on master help sign in
Merge branch 'asgardiator-cleanorg' into cleanorg
commitd102fef71a7006a1aa9131b7075bfaa53f59a37c authorC. Guy Yarvin <cgyarvin@gmail.com> dateFri 3 Jun 2016, 15:09 (10 years ago) parent645155580a987c
1 file changed+29−20
docs/using/setup.md+29−20
docs/using/setup.md+29−20
@@ -7,35 +7,38 @@ title: Setup
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 need an identity, called a "ship." A ship
15+is both a network address and a memorable name.
16+
17+You are probably creating one of two kinds of ship, a 32-bit
18+"planet" or a 128-bit "comet."
2119
22−To start with a planet (`~fintud-macrep`) and ticket (`~fortyv-tombyt-tabsen-sonres`):
20+If you have an Urbit invitation, you'll have a planet like
21+`~fintud-macrep` and `~fortyv-tombyt-tabsen-sonres`. To create
22+your pier:
2323
24− bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
24+ $ bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
2525
26−This will create a directory `fintud-macrep/` and begin the initialization process for that planet. Be patient, it can take a few minutes.
26+This will create a directory `fintud-macrep/` and begin building
27+your urbit. This may take a few minutes.
2728
28−Without a planet anyone can create a comet:
29+If you do not have a ticket, you can still make a 'comet', a wild
30+urbit drifting through cyberspace. Pick your own directory name,
31+it doesn't matter:
2932
30− bin/urbit -c comet
33+ $ bin/urbit -c mycomet
3134
32−This will create a directory `comet/` and start up a random 64-bit comet. You can specify any name you like.
35+This will create the directory `mycomet/` and generate a 128-bit identity for your urbit.
3336
3437## Orientation
3538
36−When your Urbit is finished booting you should see a `dojo>` prompt. Welcome!
39+When your urbit is finished booting you should see a `dojo>` prompt. Welcome!
3740
38−By default your Urbit is quite bare bones. Let's take a very short stroll through what's running by default:
41+By default your urbit is quite bare-bones. Let's stroll through what's already running:
3942
4043### Shell — `:dojo`
4144
@@ -52,11 +55,13 @@ Good.
5255
5356### Messaging — `:talk`
5457
55−Use `^X` to change your prompt. Let's join the main Urbit chat channel:
58+Use `^X` (ctrl-x) to change your prompt. Let's join the main Urbit chat channel:
5659
5760 ~fitund-macrep:talk() ;join ~doznec/urbit-meta
5861
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.
62+`:talk` is stateful, so your urbit will download a backlog.
63+`/urbit-meta` is the place to ask questions, get help and talk
64+about anything Urbit-related.
6065
6166### Web — `:tree`
6267
@@ -64,7 +69,11 @@ Urbit is also accessible through the web. Try opening:
6469
6570 http://localhost:8080/
6671
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).
72+in your favorite browser. You'll be prompted to use `+code`.
73+This page was generated by `:tree`, the basic Urbit web
74+interface. You can also access your urbit through
75+`http://fintud-macrep.urbit.org` (where `fintud-macrep` is your
76+planet name).
6877
6978### Filesystem — `%clay`
7079
@@ -79,7 +88,7 @@ This should produce:
7988
8089which indicates the command was processed.
8190
82−`|mount %` will cause a `home/` directory to appear inside your pier folder. Changes to these files are automatically synced into your Urbit.
91+`|mount %` will cause a `home/` directory to appear inside your pier folder. Changes to these files are automatically synced into your urbit.
8392
8493## Learn more
8594