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.

Sign up for GitHub

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

Jump to bottom

Simplify the README #1148

Open
ghost opened this issue Feb 9, 2020 · 0 comments
Open

Simplify the README #1148

ghost opened this issue Feb 9, 2020 · 0 comments

Comments

@ghost
Copy link

ghost commented Feb 9, 2020

Current Status

The README contains too much information

Expected

the usual things, something like this:

  • Description (very compact)
  • Install from Binaries (can point to online-manuals)
  • Build from Source (basic build, e.g. for ubuntu, then point to manual for more info)
    • Running Tests
    • Install
  • Contribution (tiny text, then point to manual / file)
  • Developer Resources
  • Acknowledgements
  • LICENSE
laizy added a commit that referenced this issue Feb 20, 2020
@laizy
simplify README content, 1st pass (#1151)
c1ed6fa 
* simplify README content, 1st pass, re #1148

* Apply suggestions from code review

* fix ident

Co-authored-by: laizy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
0 participants