on master help sign in
Merge pull request #525 from matildepark/patch-3

1.1: Removing redundant information, clarifying flow

commit7bea96330e3e1d7549f0156d34f5a17b61d49ba9 authorrmariani <robert@tlon.io> dateWed 19 Jun 2019, 13:18 (7 years ago) parente4ac0f3676537b
4 files changed+49−64
getting-started/_index.md+4−2 learn/hoon/hoon-tutorial/setup.md+15−62 using/_index.md+1 using/creating-a-comet.md+29
getting-started/_index.md+4−2
@@ -5,11 +5,13 @@ sort_by = "weight"
55template = "sections/docs/chapters.html"
66+++
77
8−Welcome to Urbit, a personal server. Urbit isn't ready for serious use yet, but it's available to try out. Follow this step-by-step guide to get an Azimuth point, install Urbit, and join the community.
8+Welcome to Urbit, a personal server. Urbit isn't ready for serious use yet, but it's available to try out. If you have an Azimuth point, you can follow this step-by-step guide to get your point's _keyfile_, which you need to boot your ship. Then you can install Urbit and join the community.
9+
10+If you don't have an Azimuth point, you can always [create a comet](./docs/using/creating-a-comet.md) to join the network before committing to a point, or [create a development ship](./docs/using/creating-a-development-ship.md) and start using Urbit offline first.
911
1012### [Step 1: Using Bridge](./docs/getting-started/using-bridge.md)
1113
12−In order to join the Urbit network, you need an Azimuth point, which acts like an identity and a password for your Urbit ship. Bridge is our client for managing Azimuth points. This guide tells you how to use Bridge to get your point's _keyfile_, which you need to boot your ship.
14+In order to join the Urbit network, you need an Azimuth point, which acts like an identity and a password for your Urbit ship. Bridge is our client for managing Azimuth points, and lets you get your keyfile and claim the point.
1315
1416### [Step 2: Installing Urbit](./docs/getting-started/installing-urbit.md)
1517
learn/hoon/hoon-tutorial/setup.md+15−62
@@ -5,56 +5,30 @@ template = "doc.html"
55+++
66Before we begin working on Hoon, you should first (1) have Urbit installed and (2) boot a ship that you can use for trying out Hoon examples. Interactive learning is far superior to passive reading.
77
8−## Installing Urbit
9−
10−You can install Urbit on any Mac or Unix machine; follow the steps for [creating a development ship](/docs/using/creating-a-development-ship). On Windows, make a virtual Linux machine using VirtualBox or a similar tool.
11−
12−Once you're finished you can boot your very own ship.
13−
148## What is an urbit?
159
1610An **urbit** is an Urbit virtual computer with persistent state that can connect to the Urbit network. (Note the lowercase 'u' here. 'Urbit' is the entire software stack, whereas 'an urbit' is a local instance.) Each urbit is associated with a unique number that plays three distinct roles: (1) it's an address on the Urbit network, (2) it's a cryptographic identity, and (3) it's (in principle) a human memorable name. Normally an urbit's name is represented as a string starting with `~`, as in `~zod` or `~taglux-nidsep`.
1711
1812These may not look like numbers, but they are. Each urbit name is written in a base-256 format, where each 'digit' is a syllable. Imagine your phone number as a pronounceable string which sounds like a name in a foreign language. An ordinary user-level urbit is a 'planet', and it's named by a 32-bit number. The latter is represented as a four-syllable string; e.g., the planet name `~taglux-nidsep` is the number 6,095,360.
1913
20−For this tutorial you'll boot and run what we call a 'comet'. **Comets** are urbits whose names are 128-bits or 16 syllables, such as:
21−
22−`~hillyn-pitwet-hasdur-paswer--miszod-rabpex-divrup-fogdur`
23−
24−Comet names aren't quite as memorable as others, but they're disposable identities that anyone can make for free to join the live network. Thus, comets make the ideal urbit for playing around with Hoon, asking for help from other Urbit devs in [Talk](./docs/using/messaging.md) if you need it, and showing off Urbit to your friends.
25−
26−## Booting a Comet
27−
28−To boot your comet, go into the command line and run the following command from the directory that was created during Urbit installation:
29−
30−```
31−$ urbit -c mycomet
32−```
33−
34−This will take a few minutes and will spin out a bunch of boot messages. Toward the end, you'll see something like:
14+## Installing Urbit
3515
36−```
37−ames: on localhost, UDP 31337.
38−http: live (insecure, public) on 8080
39−http: live ("secure", public) on 8443
40−http: live (insecure, loopback) on 12321
41−~palnul_nocser:dojo>
42−```
16+You can install Urbit on any Mac or Unix machine; if you're just trying out Urbit or creating a development ship, you can follow the steps for creating a development ship [here](/docs/using/creating-a-development-ship). On Windows, make a virtual Linux machine using VirtualBox or a similar tool.
4317
44−(There will likely be other messages as well.)
18+Once you're finished, you can [boot your very own ship](/docs/getting-started/booting-a-ship/#step-3-run-the-boot-command). While you can develop in Hoon on your own ship on the live network, we strongly suggest developing on a development ship first.
4519
46−Look at the prompt, `~palnul_nocser:dojo>`. To the left of the `:` you'll see an abbreviation of the comet name you just booted, `~palnul_nocser` in this case. To the right is the name of a local application, `dojo`. **Dojo** is the Urbit command line app; it's also a Hoon [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) we'll use to run simple Hoon examples.
20+## Getting started
4721
48−To make sure everything is working, type `(add 2 2)` at the prompt and hit return. Your screen now shows:
22+Once you've created your development ship, let's try a basic command. Type `(add 2 2)` at the prompt and hit return. Your screen now shows:
4923
5024```
51−ames: on localhost, UDP 31337.
52−http: live (insecure, public) on 8080
53−http: live ("secure", public) on 8443
25+fake: ~zod
26+ames: czar: ~zod on 31337 (localhost only)
27+http: live (insecure, public) on 80
5428http: live (insecure, loopback) on 12321
5529> (add 2 2)
56304
57−~palnul_nocser:dojo>
31+~zod:dojo>
5832```
5933
6034You just used a function from the Hoon standard library, `add`. Next, quit Urbit with `ctrl-d`:
@@ -62,42 +36,21 @@ You just used a function from the Hoon standard library, `add`. Next, quit Urbi
6236```
6337> (add 2 2)
64384
65−~palnul_nocser:dojo>
39+~zod:dojo>
6640$
6741```
6842
69−Your comet isn't running anymore and you're back at your computer's normal terminal prompt. You now have a `mycomet` directory for your Urbit comet; this directory is your comet's **pier** and it contains the entirety of your comet's state.
70−
71−Right now the only thing in your pier is your comet's system files:
43+Your ship isn't running anymore and you're back at your computer's normal terminal prompt. If your ship is `~zod`, then you can restart the ship by typing:
7244
7345```
74−$ ls -a /path/to/mycomet
75−./ ../ .urb/
76−```
77−
78−Restarting your already-created comet from the terminal is like creating a new one, but without the `-c` flag. (The `-c` is for "create".)
79−
80−```
81−$ urbit mycomet
82−```
83−
84−Because the comet has already been booted it won't take very long to get it running again. There are also fewer startup messages:
85−
86−```
87−$ urbit mycomet
88−[...]
89−ames: on localhost, UDP 31337.
90−http: live (insecure, public) on 8080
91−http: live ("secure", public) on 8443
92−http: live (insecure, loopback) on 12321
93−~palnul_nocser:dojo>
46+urbit zod
9447```
9548
9649## Another Noun
9750
98−You've already used a standard library function to produce one value, in the dojo. Now that your comet is running again, let's try another. Enter the number `17`.
51+You've already used a standard library function to produce one value, in the dojo. Now that your ship is running again, let's try another. Enter the number `17`.
9952
100−> We won't show the `~palnul_nocser:dojo> ` prompt from here on out. We'll just show the echoed command along with its result.
53+> We won't show the `~zod:dojo> ` prompt from here on out. We'll just show the echoed command along with its result.
10154
10255You'll see:
10356
@@ -106,7 +59,7 @@ You'll see:
1065917
10760```
10861
109−You asked dojo to evaluate `17` and it echoed the number back at you. This value is a 'noun'. But what is a noun? Move on to lesson 1.2 for the answer.
62+You asked dojo to evaluate `17` and it echoed the number back at you. This value is a 'noun'. We'll talk more about nouns in [Chapter 1.2](docs/learn/hoon/hoon-tutorial/nouns/), but first let's write a very basic program.
11063
11164## Generators
11265
using/_index.md+1
@@ -7,6 +7,7 @@ template = "sections/docs/chapters.html"
77This section contains guides to using your urbit.
88
99- [Creating a Development Ship](creating-a-development-ship) will show you how to set up the environment for coding on Urbit.
10+- [Creating a Comet](creating-a-comet) will show you how to create a comet: quick, disposable 128-bit identities on the Urbit network.
1011- [Admin and Operation](admin) is a guide to the basic commands used to interact with your ship.
1112- [Messaging](messaging) tells you how to use Talk, our chat system.
1213- [Shell](shell) is a guide to using Dojo, our command-line interface.
using/creating-a-comet.mdnew file+29
@@ -0,0 +1,29 @@
1++++
2+title = "Creating a Comet"
3+weight = 0
4+template = "doc.html"
5++++
6+
7+**Comets** are urbits whose names are 128-bits or 16 syllables, such as:
8+
9+`~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marzod`
10+
11+Comet names aren't quite as memorable as others, but they're disposable identities that anyone can make for free to join the live network.
12+
13+## Booting a Comet
14+
15+To boot your comet, go into the command line and run the following command from the directory that was created during Urbit installation:
16+
17+```
18+$ urbit -c mycomet
19+```
20+
21+This will take a few minutes and will spin out a bunch of boot messages. Toward the end, you'll see something like:
22+
23+```
24+ames: on localhost, UDP 31337.
25+http: live (insecure, public) on 8080
26+http: live ("secure", public) on 8443
27+http: live (insecure, loopback) on 12321
28+~dasres_marzod:dojo>
29+```