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

First version of docs #24

Draft
wants to merge 2 commits into
base: petar/p1
Choose a base branch
from
Draft

First version of docs #24

wants to merge 2 commits into from

Conversation

adlrocha
Copy link
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
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@adlrocha