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

Readme should be reorganized #636

Closed
stleary opened this issue Oct 16, 2021 · 2 comments · Fixed by #637
Closed

Readme should be reorganized #636

stleary opened this issue Oct 16, 2021 · 2 comments · Fixed by #637

Comments

@stleary
Copy link
Owner

stleary commented Oct 16, 2021

The readme has too much unrelated content.
These sections should remain:
Header (image, title, Maven links)
Overview
If you would like to contribute
Build instructions

These sections should be removed. Leave a copy of the section header, but add a line that links to the new .md file. See the If you would like to contribute section for an example of how to do this.
Notes: Extract content, move to a new NOTES.md file
Files: Extract content, move to a new FILES.md file
Release History: Extract content, move to a new RELEASES.md file

@Ronqn
Copy link
Contributor

Ronqn commented Oct 16, 2021

Hello, can you assign me this issue? Would love to work on it.

@stleary
Copy link
Owner Author

stleary commented Oct 16, 2021

@Ronqn Sure go ahead. The main readme should stay in the root directory, I think. But if you decide to put the new files and the other existing contributions file into a docs directory, that would be fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants