Initial README draft#63
Closed
aymannel wants to merge 1 commit into
Closed
Conversation
Collaborator
|
I think we need to separate between documentation targeting end users and documentation for developers. Usually, the README is a place for the first. Public documentation should be concerned with installing and using the library (from Python or Rust), and maybe manually building for those who want it. Developer documentation should include how to set up the environment, build and test, set up commit hooks, and the internal structure. It can contain internals such as the private fields of data structures. |
Collaborator
|
As for developer documentation, maybe we could use the Github wiki? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds an initial README for SynIR. Preview rendered README here.
Required sections
Open to suggestions/changes, however (whilst this README is a work in progress), it might be easier to merge this initial draft so that we have something to work with. Then others can raise PRs adding their changes to the relevant sections as they see fit.