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

repo: update readme #32

Open
1 of 4 tasks
buck54321 opened this issue Dec 21, 2019 · 2 comments
Open
1 of 4 tasks

repo: update readme #32

buck54321 opened this issue Dec 21, 2019 · 2 comments
Assignees

Comments

@buck54321
Copy link
Member

buck54321 commented Dec 21, 2019

  • Expand overview. Remove overview header. The description can just go below the title.
  • Move build status to the bottom, or at least below the fold. It is not important for most visitors.
  • Add section about current budget and objectives. Replaces the roadmap section.
  • Add contributing / development section. Can be a link to a separate file.
  • Add some small code examples. We moved the bigger examples to various scripts in create example scripts #6, but a couple smaller examples to demonstrate simple tasks would be great.
@teknico
Copy link
Collaborator

teknico commented Dec 21, 2019

Maybe add a "Development" section too, unless it's the same as the "Contributing" one? It should mention pytest, black, flake8 and the .github/workflows/python.yml file. (I forgot to add it as part of #27, sorry.)

@teknico
Copy link
Collaborator

teknico commented Jan 22, 2020

I'm working on the README as part of #59. There will be three README files: the current one at the top of the repo and one for each of the decred and tinywallet packages. The decred one will include the text currently in pydecred/README.md.

I'm not sure we should de-emphasize the build status: it's significant to project users as an indication of health and ongoing maintenance, and the placement at the top of the main README is common and expected on Github.

I'll add a CONTRIBUTING.md file with a "Development" section, and link to it from the main README.

I'll leave the other items to you.

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

No branches or pull requests

2 participants