Add documentation for Stone Binaries and removed overlapping instruction from README #40
Conversation
|
hello @dmirgaleev I have implemented the required changes, please review for merging and let me know if to make any changes or improvement where necessary |
docs/pages/install/binaries.md
Outdated
| source ~/.zshrc | ||
| ``` | ||
|
|
||
| 4. Apply the changes by running: |
There was a problem hiding this comment.
Is there a reason to do source ~/.bashrc twice (step 3 and 4)?
There was a problem hiding this comment.
hello @dmirgaleev. I will remove the redundant step right. Had network issues day but fixed now
README.md
Outdated
| @@ -85,11 +83,6 @@ docker pull ghcr.io/dipdup-io/stone-packaging/stone-prover:latest | |||
|
|
|||
| ### Creating and Verifying a Test Proof Using Docker | |||
|
|
|||
| Clone the repository: | |||
There was a problem hiding this comment.
Let's download https://github.com/dipdup-io/stone-packaging?tab=readme-ov-file#download-binaries-for-x86_64 instead of cloning, we still need to clone the repo to create a verify a test proof
|
Hello @dmirgaleev I have implemented the changes please review. thanks |
| After placing the binaries or updating the PATH, you can verify the installation by running: | ||
|
|
||
| ```bash | ||
| cpu_air_prover --help |
There was a problem hiding this comment.
Does that work for you? What output do you get?
There was a problem hiding this comment.
hello @dmirgaleev it kinda worked but came up with some feedback which incudes a warning: 'SetUsageMessage() never called', just thought that since its not a critical error but a warning then it should still work. seems I will have to go around that and send in any update and progress
There was a problem hiding this comment.
just to mention that previously when i use the command source ~/.bashrc to reload my .bashrc it did come up with errors such as "line 102: syntax error near unexpected token `then'
" and "line 114: syntax error: unexpected end of file
". so had to go into my shell configuration file and correct the syntax error and made sure indentations are fixed correctly before it reloaded properly
README.md
Outdated
| @@ -25,6 +25,9 @@ Follow-up work: | |||
|
|
|||
| ## Usage Instructions | |||
|
|
|||
| ### Downloading Binaries | |||
There was a problem hiding this comment.
Let's leave it as it was before
README.md
Outdated
| ```bash | ||
| git clone https://github.com/dipdup-io/stone-packaging.git /tmp/stone-packaging | ||
| ``` | ||
| Note: You still need to clone the repo to create and verify a test proof. |
There was a problem hiding this comment.
Let's leave it as it was before
There was a problem hiding this comment.
ok will do that. implementing changes now
README.md
Outdated
| @@ -43,20 +46,14 @@ wget https://github.com/dipdup-io/stone-packaging/releases/latest/download/cpu_a | |||
|
|
|||
| ### Creating and Verifying a Test Proof Using Binaries | |||
|
|
|||
| Clone the repository: | |||
There was a problem hiding this comment.
The same, we still need that. Please, try to reproduce the instructions you provided
|
Resolves #23 |
This pull request includes the following updates:
This contribution makes the instructions clearer by moving the binary installation steps to a separate document and making the README.md clean and easier to read. Thanks