on master help sign in
explain terminology, add details to setup instructions
commit253179782362961b9d836e22481bdf0ab567afdc authorTobias Merkle <tgamerkle@gmail.com> dateWed 25 May 2016, 10:32 (10 years ago) parent418ce1b
1 file changed+16−22
docs/using/setup.md+16−22
docs/using/setup.md+16−22
@@ -7,35 +7,29 @@ navhome: /docs
77
88# Getting started
99
10−<div class="row">
11−<div class="col-md-8">
12−
13−On disk your Urbit is an append-only log and a checkpoint. Or, in simpler terms, a directory where we keep all of your Urbit’s state. We call this a ‘pier’.
14−
15−</div>
16−</div>
10+On disk your urbit is an append-only log and a checkpoint. Or, in simpler terms, a directory where we keep your urbit’s state. We call this a ‘pier’.
1711
1812## Initialize
1913
20−When you first start an Urbit we create this pier directory and write to it.
14+To create an urbit, we must make a pier and assign it an identity. An urbit with an identity is a 'planet', if it was generated by a 'star' (an urbit that makes more urbits. Accordingly, a 'galaxy' is an urbit that makes stars).
2115
22−To start with a planet (`~fintud-macrep`) and ticket (`~fortyv-tombyt-tabsen-sonres`):
16+To make a planet, you need a ticket from a star. If you have a ticket, like `~fortyv-tombyt-tabsen-sonres`, start your planet `~fintud-macrep` like so:
2317
24− bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
18+ $ bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
2519
26−This will create a directory `fintud-macrep/` and begin the initialization process for that planet. Be patient, it can take a few minutes.
20+This will create a directory `fintud-macrep/` and begin building your urbit. Assembling a planet may take a few minutes.
2721
28−Without a planet anyone can create a comet:
22+If you do not have a ticket, you can still make a 'comet', a parentless urbit drifting thorugh cyberspace. You can specify any name you like.
2923
30− bin/urbit -c comet
24+ $ bin/urbit -c comet
3125
32−This will create a directory `comet/` and start up a random 64-bit comet. You can specify any name you like.
26+This will create the directory `comet/` and generate a 64-bit identity for your urbit.
3327
3428## Orientation
3529
36−When your Urbit is finished booting you should see a `dojo>` prompt. Welcome!
30+When your urbit is finished booting you should see a `dojo>` prompt. Welcome!
3731
38−By default your Urbit is quite bare bones. Let's take a very short stroll through what's running by default:
32+By default your urbit is quite bare-bones. Let's stroll through what's already running:
3933
4034### Shell — `:dojo`
4135
@@ -52,11 +46,11 @@ Good.
5246
5347### Messaging — `:talk`
5448
55−Use `^X` to change your prompt. Let's join the main Urbit chat channel:
49+Use `^X` (ctrl-x) to change your prompt. Let's join the main urbit chat channel:
5650
5751 ~fitund-macrep:talk() ;join ~doznec/urbit-meta
5852
59−This may take a bit as `:talk` is stateful so your Urbit will download some backlog. `/urbit-meta` is the place to ask questions, get help and talk about anything Urbit related.
53+`:talk` is stateful, so your urbit will download a backlog. `/urbit-meta` is the place to ask questions, get help and talk about anything Urbit-related.
6054
6155### Web — `:tree`
6256
@@ -64,7 +58,7 @@ Urbit is also accessible through the web. Try opening:
6458
6559 http://localhost:8080/
6660
67−in your favorite browser. You'll be prompted to use `+code`. This page was generated by `:tree`, the basic Urbit web interface. You can also access your Urbit through `http://fintud-macrep.urbit.org` (where `fintud-macrep` is your planet name).
61+in your favorite browser. You'll be prompted to use `+code`. This page was generated by `:tree`, the basic urbit web interface. You can also access your urbit through `http://fintud-macrep.urbit.org` (where `fintud-macrep` is your planet name).
6862
6963### Filesystem — `%clay`
7064
@@ -79,7 +73,7 @@ This should produce:
7973
8074which indicates the command was processed.
8175
82−`|mount %` will cause a `home/` directory to appear inside your pier folder. Changes to these files are automatically synced into your Urbit.
76+`|mount %` will cause a `home/` directory to appear inside your pier folder. Changes to these files are automatically synced into your urbit.
8377
8478## Learn more
8579
@@ -87,6 +81,6 @@ We go into much greater detail about using each of these components in our walkt
8781
8882<list src="."></list>
8983
90−With your Urbit up and running you know enough to start learning to program:
84+With your urbit up and running, you know enough to start learning to program:
9185
92−<list src="../programming/deep"></list>
86+<list src="../hoon/"></list>