Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mrigan/new readme #234

Merged
merged 18 commits into from
Aug 15, 2023
Merged

Mrigan/new readme #234

merged 18 commits into from
Aug 15, 2023

Conversation

MRiganSUSX
Copy link
Contributor

Creating (actual) README for the trigger.

Aimed to help newcomers, also explains development and briefly touches on running.
Links used for portions that evolve quickly.

Copy link
Contributor

@ArturSztuc ArturSztuc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've already looked at the document a couple of times and made suggestion etc. offline -- it looks good to me, and I am happy with this README being approved without further changes.

I have made a few suggestions, but they are all small grammar things that can be omitted at this PR. Further changes, like optimizing the explanations and linking multiple documents etc. can be done at a later date, the most important thing now is to have a README, and this one is already well-written.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MRiganSUSX
Copy link
Contributor Author

Thanks Artur, I have accepted all your comments.

Copy link
Contributor

@bieryAtFnal bieryAtFnal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@MRiganSUSX MRiganSUSX merged commit b6b0739 into develop Aug 15, 2023
2 checks passed
@MRiganSUSX MRiganSUSX deleted the mrigan/new_readme branch August 15, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants