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

Draft: Update readme #106

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Draft: Update readme #106

wants to merge 2 commits into from
+13 −92

Conversation

jazzthief
Copy link
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
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
Reviewers

@MaksimPerkovskiy MaksimPerkovskiy

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs Improvements or additions to documentation housekeeping Chores: keeping the repo/codebase clean
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update README
1 participant
@jazzthief