Skip to content

First version of docs#24

Draft
adlrocha wants to merge 2 commits intopetar/p1from
docs/v0.1
Draft

First version of docs#24
adlrocha wants to merge 2 commits intopetar/p1from
docs/v0.1

Conversation

@adlrocha
Copy link
Copy Markdown
Contributor

This PR adds the project documentation.

  • README file with overview of SR, packages included, and pointing to GoDocs and examples.
    • TODO: Point to GoDocs
  • doc.go in packages with one-line description
  • Packages exhaustive docs and examples
    • ir
    • ir/base
    • xr
    • vm
    • protocol
    • examples

Waiting for #20, #21, #22 to be merged before addressing exhaustive package docs to avoid conflicts.

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

Successfully merging this pull request may close these issues.

1 participant