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

Update README with tutorial and installation instructions #45

Open
lopeetall opened this issue Feb 21, 2023 · 2 comments
Open

Update README with tutorial and installation instructions #45

lopeetall opened this issue Feb 21, 2023 · 2 comments
Assignees
@lopeetall @AHartNtkn @CarloModicaPortfolio

Comments

@lopeetall
Copy link
Contributor

No description provided.

@cwgoes
Copy link

cwgoes commented Mar 5, 2023

Yeah, I think it would be nice to have the README focus on a simple tutorial, and link to the VampIR book (once online) for full documentation. Also, I think we should explain a bit how VampIR relates to Juvix, to Taiga to possibly other higher-level languages which might compile to it, and to individual backends / proof systems.

Also, it looks like the links to "Design rationale" and "spec" are broken. This is because the specs repository has changed layout, but I think we should just move these files into the VampIR repository (or perhaps the VampIR book) directly.

@cwgoes
Copy link

cwgoes commented Mar 5, 2023

Oh - and the README should definitely show the benchmarks (especially the good ones 😀)

@lopeetall lopeetall mentioned this issue Mar 24, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lopeetall lopeetall

@AHartNtkn AHartNtkn

@CarloModicaPortfolio CarloModicaPortfolio

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@lopeetall @AHartNtkn @cwgoes @CarloModicaPortfolio