on master help sign in
Merge pull request #50 from leobauza/starter-docs-improvements

Update getting started documentation

commite2a04f13db748ee6dc321ccc0b3511aec39908af authorMorgan Sutherland <msutherl@users.noreply.github.com> dateTue 5 Mar 2019, 15:43 (8 years ago) parent1a7c06804e8844
2 files changed+13−5
README.md+12−4 static-site/docs+1−1
README.md+12−4
@@ -2,15 +2,23 @@
22
33## Test and Develop in Arvo
44
5+This guide assumes [Arvo has been installed](https://urbit.org/docs/getting-started/#arvo).
6+
7+> Note: installing Arvo and the step below to use the Arvo repo are *not* the same thing.
8+
591. Make sure that all of the necessary submodules (docs) are up to date by running `git submodule init` and then `git submodule update --recursive --remote` in this repo
610
7−2. Make a fakezod, using [this branch](https://github.com/urbit/arvo/tree/static-site-dev). It just has a few different renderers and marks for svgs, images, etc. Use the command `urbit -F zod -A <path/to/arvo/repo> -s -c zod -S`
11+2. Clone the [Arvo repo](https://github.com/urbit/arvo) `git clone git@github.com:urbit/arvo.git` and use [this branch](https://github.com/urbit/arvo/tree/static-site-dev) `cd arvo && git co -b static-site-dev origin/static-site-dev`. It has a few different renderers and marks for svgs, images, etc
12+
13+3. Make a [fakezod](https://urbit.org/docs/getting-started/#using-a-fake-ship-) using the Arvo branch. Use the command `urbit -F zod -A <path/to/arvo/repo> -sc zod -S`
14+
15+4. If you've successfully booted your Urbit you should see the Dojo prompt: `~zod:dojo>`, if instead you see: `~zod:talk[]` type `ctrl-x` to switch to the Dojo prompt
816
9−3. In the running fakezod, mount the filesystem by running `|mount %`
17+5. In the running fakezod, mount the filesystem by running `|mount %`
1018
11−4. Run `./scripts/topier <path/to/pier>` from this directory to copy the pertinent files to your pier
19+6. On a different terminal run `./scripts/topier <path/to/pier>` from this directory to copy the pertinent files to your pier (the pier is the `zod` directory created in step 3)
1220
13−5. Visit `localhost:80` to see the rendered urbit.org
21+7. Go to your pier directory `cd <path/to/pier` and view the contents of `.http.ports`. Navigate to localhost at the port labeled `insecure public` e.g. visit `localhost:8080` to see the rendered urbit.org if you see `8080 insecure public`
1422
1523## To render/export
1624
static-site/docs+1−1

Submodule changed.