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

Improve readme so that devs can self-serve. #19

Closed
4 of 6 tasks
Tracked by #15
frankiebee opened this issue Dec 19, 2023 · 2 comments · Fixed by #100
Closed
4 of 6 tasks
Tracked by #15

Improve readme so that devs can self-serve. #19

frankiebee opened this issue Dec 19, 2023 · 2 comments · Fixed by #100
Assignees
@johnnymatthews @rh0delta
Labels
anchor Issue lists to encapsulate a concept documentation Improvements or additions to documentation

Comments

@frankiebee
Copy link
Collaborator

frankiebee commented Dec 19, 2023 •
edited by johnnymatthews
Loading

README should include clear usage examples, setup instructions for development, documentation for each action, etc. Essentially, what docs.entropy.xyz does, but within this project's README.

Tasks

  • Install
    • Prerequisites
  • Basic usage instructions
  • Troubleshooting
  • Contributing to this repo
  • Licence
@frankiebee frankiebee mentioned this issue Dec 19, 2023
Closed
5 tasks
@jawndiego jawndiego added this to the Open sourcing milestone Dec 19, 2023
@frankiebee frankiebee mentioned this issue Dec 19, 2023
Closed
@mixmix mixmix added the documentation Improvements or additions to documentation label Jun 10, 2024
@johnnymatthews johnnymatthews changed the title readme Improve readme so that devs can self-serve without having to jump to the docs. Jun 10, 2024
@johnnymatthews johnnymatthews changed the title Improve readme so that devs can self-serve without having to jump to the docs. Improve readme so that devs can self-serve. Jun 10, 2024
This was referenced Jun 12, 2024
Closed
Merged
@frankiebee
Copy link
Collaborator Author

related to #18

@frankiebee
Copy link
Collaborator Author

related #15

@frankiebee frankiebee added the anchor Issue lists to encapsulate a concept label Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnnymatthews johnnymatthews

@rh0delta rh0delta

Labels
anchor Issue lists to encapsulate a concept documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improves README for self-surface. entropyxyz/cli
5 participants
@mixmix @johnnymatthews @frankiebee @rh0delta @jawndiego