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.

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

Completed installation and quickstart sections #1065

Merged
merged 3 commits into from
Dec 16, 2024

Conversation

HrikB
Copy link
Contributor

@HrikB HrikB commented Dec 16, 2024

This PR completes the installation and quickstart sections of the book.

Closes INT-2881

Copy link

linear bot commented Dec 16, 2024

INT-2881 Install and quickstart

can mostly copy https://docs.succinct.xyz/docs/getting-started/install

but ours is simpler right now:

Install cargo openvm from source:

  1. either clone the repo and cargo install --force --path . from crates/cli or
  2. cargo install --git (I've never tried this and it might only work with public repo)

We don't need to install any special toolchains, just nightly-2024-10-30

For quickstart, add example of writing fibonacci program, starting from cargo init , add openvm = { …, features = ["std"] } and include the guest program code. We don't need the no_main, no_std stuff for quickstart since std works. Copy the rest of fibonacci from the benchmark, in particular use read.

Give the commands on how to run it using cargo openvm run or cargo openvm bench (hopefully that works).

  • we have --input here, will need to figure out how to use it

@HrikB HrikB requested a review from jonathanpwang December 16, 2024 01:54
Copy link
Contributor

@jonathanpwang jonathanpwang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated for latest cli

@jonathanpwang jonathanpwang merged commit aea81bf into main Dec 16, 2024
2 checks passed
@jonathanpwang jonathanpwang deleted the docs/installation-and-quickstart branch December 16, 2024 04:15
arayikhalatyan pushed a commit that referenced this pull request Dec 16, 2024
* docs: completed installation and quickstart sections

* Apply suggestions from code review

* update cli

---------

Co-authored-by: Jonathan Wang <[email protected]>
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.

3 participants