docs: update readme with instructions for Dockerized environment #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NickVolynkin
force-pushed
the
readme
branch
5 times, most recently
from
54d4474
to
de8fa03
Compare
Rename ci.sh to run.sh. The main purpose of this script is not to facilitate CI. It is to give developers who take the course a super-easy and reliable way to go through it. We only test it in CI to check that it works when developers use it. Do the `set -x` explicitly with the `--verbose` key. We need this setting in CI and when developing the code in the workflow. Although, developers who take the course don't need all this extra noise in their console.
NickVolynkin
force-pushed
the
readme
branch
24 times, most recently
from
6009f51
to
ada05a3
Compare
NickVolynkin
force-pushed
the
readme
branch
14 times, most recently
from
257f13f
to
3378a1e
Compare
The `proof-generator` binary looks for the config in ~/.config/config.ini. As we run the container with `--user`, the username inside the container is one of three options: * The `root`, if the host user is also `root`; in this case the config directory is `/root/.config/`. * An unnamed user with given id; in this case the username is empty, so the config directory is `/.config/`. * A named user with the same id as on the host; it can happen only if the developer has made a custom image by adding something like this: ```Dockerfile RUN useradd -u 1337 -m zkdev USER zkdev ``` It's the safest option, but we can't expect everyone to do it as we try to make the tutorial as simple as possible. Workaround for NilFoundation/proof-market-toolchain#61
alexandra-mara
suggested changes
Jul 10, 2023
nkaskov
approved these changes
Jul 10, 2023
Update two sections: * Introduction: cloning the repository and getting Docker images. * Local development workflow: compile a circuit, make a statement, make a proof. Add a table of contents, made with `doctoc`: ```bash npm install -g doctoc doctoc README.md ``` The section with Proof Market is almost untouched and very much out of date. Will update it in #21 Resolve #4 Resolve #18i
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs: update readme with instructions for Dockerized environment
Update two sections:
Add a table of contents, made with
doctoc:The section with Proof Market is almost untouched and very much out of date. Will update it in #21
Preview the updated instructions in https://github.com/NilFoundation/zkllvm-template/blob/readme/README.md.
Resolve #4
Resolve #18
run.sh: rename script and explicitly run in verbose mode
Rename ci.sh to run.sh.
The main purpose of this script is not to facilitate CI.
It is to give developers who take the course a super-easy and reliable
way to go through it.
We only test it in CI to check that it works when developers use it.
Do the
set -xexplicitly with the--verbosekey.We need this setting in CI and when developing the code in the workflow.
Although, developers who take the course don't need all this extra noise
in their console.
run.sh: make config.ini available in all conditions
The
proof-generatorbinary looks for the config in~/.config/config.ini. As we run the container with
--user,the username inside the container is one of three options:
The
root, if the host user is alsoroot; in this case the configdirectory is
/root/.config/.An unnamed user with given id; in this case the username is empty,
so the config directory is
/.config/.A named user with the same id as on the host; it can happen only if
the developer has made a custom image by adding something like this:
It's the safest option, but we can't expect everyone to do it as we
try to make the tutorial as simple as possible.
Workaround for NilFoundation/proof-market-toolchain#61