Skip to content

Draft: Update readme#106

Open
jazzthief wants to merge 2 commits intomainfrom
105_update_readme
Open

Draft: Update readme#106
jazzthief wants to merge 2 commits intomainfrom
105_update_readme

Conversation

@jazzthief
Copy link
Copy Markdown
Contributor

Closes #105. Updates to README in preparation for open sourcing the project, plus minor additions to CONTRIBUTING.md. The dev setup instructions are removed, since they have already been added to CONTRIBUTING.md

@jazzthief jazzthief added docs Improvements or additions to documentation housekeeping Chores: keeping the repo/codebase clean labels May 30, 2023
@jazzthief
Copy link
Copy Markdown
Contributor Author

I've added the general structure of the README with some comments. Things that need to be added:

  • "Getting started": brief instructions on how to use the project for the end users
  • Links to RFCs/specs that we are using in the "References" section and throughout the docs, as indicated by markdown comments.

I think it's better that you discuss these and add them yourselves to avoid any inaccuracies.

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

Labels

docs Improvements or additions to documentation housekeeping Chores: keeping the repo/codebase clean

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README

1 participant