@@ -10,45 +10,45 @@ This guide is broken into five parts:
10+ [Acquiring an Urbit Identity](#acquire)
10+ [Acquiring an Urbit Identity](#acquire)
11+ [Using Bridge](#bridge)
11+ [Using Bridge](#bridge)
12+ [Installing Arvo](#arvo)
12+ [Installing Arvo](#arvo)
13−+ [Booting Your Ship](#setup)
13++ [Booting Your Ship](#boot)
14+ [Basic Operations](#operation)
14+ [Basic Operations](#operation)
16−_If you just want to install the Urbit OS, Arvo, and don’t need to be on the
16+_If you just want to install the Urbit OS, Arvo, and don't need to be on the
17Urbit network, you can skip to [Installing Arvo](#arvo)._
17Urbit network, you can skip to [Installing Arvo](#arvo)._
22 ;div(id "acquire"): Acquiring an Urbit Identity
21 ;div(id "acquire"): Acquiring an Urbit Identity
26−Urbit’s identity layer, called Azimuth, is a suite of contracts on the Ethereum
25+Urbit's identity layer, called Azimuth, is a suite of contracts on the Ethereum
27blockchain. An Azimuth address, called a *point*, functions as an identity and
26blockchain. An Azimuth address, called a *point*, functions as an identity and
28a network address for Arvo, the Urbit OS. An instance of Arvo is called a
27a network address for Arvo, the Urbit OS. An instance of Arvo is called a
29*ship*. A ship can't use the Arvo network until it's combined with a point.
28*ship*. A ship can't use the Arvo network until it's combined with a point.
31−Throughout this guide, we’ll refer to "Urbit identities" and "points"
30+Throughout this guide, we'll refer to \"Urbit identities\" and \"points\"
32interchangeably.
31interchangeably.
34Points are generally not freely available, so you will need to either
33Points are generally not freely available, so you will need to either
35purchase one or get one from a friend. This guide assumes you have found a way
34purchase one or get one from a friend. This guide assumes you have found a way
36to acquire a point.
35to acquire a point.
38−To get Urbit address space, you’ll need two things: an Ethereum address and a
37+To get Urbit address space, you'll need two things: an Ethereum address and a
39person willing to send you the Urbit address space.
38person willing to send you the Urbit address space.
41−You’ll probably want to start with a planet. Those are cheap identities for
40+You'll probably want to start with a planet. Those are cheap identities for
42everyday use. Find someone who is willing to part with a point: a friend or a
41everyday use. Find someone who is willing to part with a point: a friend or a
43−stranger selling address space via smart contract. Once they’ve sent the address
42+stranger selling address space via smart contract. Once they've sent the address
44space, you can access it using our Bridge software, or any other interface for
43space, you can access it using our Bridge software, or any other interface for
45−the Ethereum blockchain.
44+the Ethereum blockchain. Make sure they send you the name of the point, which
45+looks something like `~lodleb-ritrul`.
47If you bought address space from Tlon, then you should have have received a .zip
47If you bought address space from Tlon, then you should have have received a .zip
48file that contains an Ethereum address and cryptographic secrets in
48file that contains an Ethereum address and cryptographic secrets in
49the form of a PDF.
49the form of a PDF.
51−Your ownership PDF contains two secrets that must be kept safe.""
51+Your ownership PDF contains two secrets that must be kept safe.
53- *Master Ticket*: This is a master key that allows you to manage every aspect of
53- *Master Ticket*: This is a master key that allows you to manage every aspect of
54 your address.
54 your address.
@@ -58,36 +58,82 @@ Your ownership PDF contains two secrets that must be kept safe.""
62 ;div(id "bridge"): Using Bridge
62 ;div(id "bridge"): Using Bridge
66Bridge is client that we built for accessing and managing your Urbit identities.
66Bridge is client that we built for accessing and managing your Urbit identities.
67Like Wallet Generator, Bridge comes in the form of an offline HTML application
67Like Wallet Generator, Bridge comes in the form of an offline HTML application
68−that can be run in Firefox on all platforms, and also in Chrome if you’re using
68+that can be run in Firefox on all platforms, and also in Chrome if you're using
71−Importantly, Bridge also automates the process of generating the key-file that
71+Importantly, Bridge also automates the process of generating the keyfile that
72you will need a single time to boot your ship on the Arvo network. Once a ship
72you will need a single time to boot your ship on the Arvo network. Once a ship
73−is booted, it isn’t booted again. It stays booted forever.
73+is booted, it isn't booted again. It stays booted forever.
75+Download bridge [here](https://github.com/urbit/bridge/releases) and follow
76+the instructions below.
80+Click `Open a Wallet`.
82+#### Step 2: Select a Network
84+On the dropdown menu, make sure that `Main Network` is selected. Then click
87+#### Step 3: Open a Wallet
89+On this dropdown menu, choose how you'd like to access your Ethereum wallet.
90+If you aren't using Hardware wallets (a Ledger or a Trezor), you'll want to use
91+your Ethereum wallet's BIP39 Mnemonic.
93+If you received a point from Tlon and received paper wallets in the form of
94+PDFs, choose `Urbit Master Ticket`.
96+Select the appropriate option and click `Continue ->`.
98+#### Step 4: Accept Your Transfer
75−Download bridge [here](https://github.com/urbit/bridge/releases). It runs in
100+If you were sent a point, then you should see a graphic under
76−your browser contains instructions to get the key that you need to boot your
101+`Incoming Transfers`. Click the `Details ->` link under that graphic.
77−urbit. We recommend using the "BIP39 Mnemonic" method to access your wallet.
102+
103+Now you'll be on the management page of your point. The transfer isn't completed
104+yet, so click `Accept incoming transfer`. Then check both boxes and and click
105+their associated `Sign Transaction` and `Send Transaction` buttons.
107+#### Step 5: Set Your Networking Keys
109+You'll be returned to your point screen. Notice that that links and buttons
110+are now clickable. You know own this point!
112+Click the link that says `Set Urbit networking keys`. Choose two different,
113+64-character long strings of hexademical, check the box, and, like before, check
114+both boxes and press both buttons.
116+#### Step 6: Generate Your Keyfile
118+Return to your point by clicking its name at the navigation bar on the top of
121+Click the `Generate Urbit Keyfile` button and you'll be taken to a page with a
122+field titled `Network key`. That field should be filled in already. Click
123+`Generate ->`, which will download a the keyfile onto your machine.
82 ;div(id "arvo"): Installing Arvo
128 ;div(id "arvo"): Installing Arvo
86−Now you’re ready to install the Arvo software. You’re almost there!
132+Now you're ready to install the Arvo software. You're almost there!
88Arvo can only run on a Unix-like operating system -- Ubuntu,
134Arvo can only run on a Unix-like operating system -- Ubuntu,
89−Fedora, macOS, and FreeBSD all work well. If you’re using Windows, you’ll need
135+Fedora, macOS, and FreeBSD all work well. If you're using Windows, you'll need
90−to get one of the aforementioned systems. Don’t worry: most of them are free.
136+to get one of the aforementioned systems. Don't worry: most of them are free.
92We have different installation instructions for different platforms. To install
138We have different installation instructions for different platforms. To install
93Arvo, run the Bash commands that are listed for your operating system.
139Arvo, run the Bash commands that are listed for your operating system.
@@ -100,7 +146,7 @@ with the line below:
100Urbit: a personal server operating function
146Urbit: a personal server operating function
103−##### MacOS
149+#### MacOS
105We recommend using the Homebrew package manager to install Arvo on MacOS.
151We recommend using the Homebrew package manager to install Arvo on MacOS.
@@ -117,7 +163,7 @@ sudo ninja -C ./build/ meson-install
120−##### Ubuntu or Debian
166+#### Ubuntu or Debian
@@ -147,7 +193,7 @@ sudo ninja -C ./build/ install
150−##### Fedora
196+#### Fedora
@@ -187,7 +233,7 @@ sudo /usr/local/bin/ninja -C ./build/ install
190−##### Arch Linux
236+#### Arch Linux
@@ -213,36 +259,38 @@ urbit -F zod -A /path/to/arvo -s -c zod -S
214If you want to get on the Arvo network with your point, then continue to the
260If you want to get on the Arvo network with your point, then continue to the
215next section.
261next section.
219 ;div(id "boot"): Booting Your Urbit
266 ;div(id "boot"): Booting Your Urbit
223−Now the rubber meets the road. You’ll be booting your ship with the key-file
271+Now the rubber meets the road. You'll be booting your ship with the keyfile
224that you downloaded from bridge.
272that you downloaded from bridge.
226−##### Step 1: Find Your Point's Name
274+#### Step 1: Find Your Point's Name
228This will look something like `~lodleb-ritrul`. You can see the name of your
276This will look something like `~lodleb-ritrul`. You can see the name of your
229point(s) when you log into your wallet using the Bridge client.
277point(s) when you log into your wallet using the Bridge client.
231;img@"media.urbit.org/site/bridge-0.png"(width "100%");
279;img@"media.urbit.org/site/bridge-0.png"(width "100%");
233−##### Step 2: Find the path to your key-file
281+#### Step 2: Find the path to your keyfile
235−Find the absolute path to the key-file that you downloaded from Bridge. Copy it.
283+Find the absolute path to the keyfile that you downloaded from Bridge. Copy it.
237−##### Step 3: Run the boot command
285+#### Step 3: Run the boot command
239Type `cd` in your terminal to return to your home directory. If you want to
287Type `cd` in your terminal to return to your home directory. If you want to
240−store your ship somewhere besides your home directory, change the terminal’s
288+store your ship somewhere besides your home directory, change the terminal's
241working directory to the desired directory.
289working directory to the desired directory.
243Run the command below, except with `~sample-planet` replaced by the name of your
291Run the command below, except with `~sample-planet` replaced by the name of your
244Urbit identity, and `path/to/my-planet.key` replaced with the path to your
292Urbit identity, and `path/to/my-planet.key` replaced with the path to your
245−key-file:
293+keyfile:
248urbit -w ~sample-planet -k path/to/my-planet.key
296urbit -w ~sample-planet -k path/to/my-planet.key
@@ -252,20 +300,20 @@ This will create a directory called `sample-planet/` and begin building your
252ship. It may take a few minutes.
300ship. It may take a few minutes.
254When your ship is finished booting, you will see the `~sample-planet:dojo>`
302When your ship is finished booting, you will see the `~sample-planet:dojo>`
255−prompt. At that point, you should permanently erase your key-file from your
303+prompt. At that point, you should permanently erase your keyfile from your
260 ;div(id "operation"): Basic Operations
308 ;div(id "operation"): Basic Operations
264Welcome to your urbit! There's a few things you should do to become oriented.
312Welcome to your urbit! There's a few things you should do to become oriented.
266−##### Dojo
314+#### Dojo
268−Let’s try out the Dojo, the Arvo command line and Hoon REPL:
316+Let's try out the Dojo, the Arvo command line and Hoon REPL:
271~sample-planet:dojo> (add 2 2)
319~sample-planet:dojo> (add 2 2)
@@ -280,7 +328,7 @@ Should produce:
283−##### Mounting
331+#### Mounting
285Clay, the Arvo filesystem, isn't mounted to Unix by default. Switch to the Dojo
333Clay, the Arvo filesystem, isn't mounted to Unix by default. Switch to the Dojo
286prompt and run:
334prompt and run:
@@ -301,11 +349,11 @@ which indicates that the command was processed.
301Unix. Changes to these files are automatically synced into your ship.
349Unix. Changes to these files are automatically synced into your ship.
304−##### Talk
352+#### Talk
306Use `ctrl-x` to toggle between the Dojo and the Talk prompts.
354Use `ctrl-x` to toggle between the Dojo and the Talk prompts.
308−While on the Talk prompt, let’s join the main Urbit chat channel, `/urbit-meta`:
356+While on the Talk prompt, let's join the main Urbit chat channel, `/urbit-meta`:
311~sample-planet:talk[] ;join /urbit-meta
359~sample-planet:talk[] ;join /urbit-meta
@@ -315,7 +363,7 @@ Talk is stateful, so your ship will download a backlog. `/urbit-meta` is the
315place to ask questions, get help, talk about anything Urbit-related, and meet
363place to ask questions, get help, talk about anything Urbit-related, and meet
316everyone on here.
364everyone on here.
318−##### Shutting Down and Restarting
366+#### Shutting Down and Restarting
320You can turn your ship off with `ctrl-d` from the Talk or Dojo prompts.
368You can turn your ship off with `ctrl-d` from the Talk or Dojo prompts.
@@ -324,13 +372,13 @@ To restart your ship, simply pass the name of your pier:
325$ urbit some-planet
373$ urbit some-planet
328−##### Landscape
376+#### Landscape
330Your ship is also accessible through its own web interface. Through the web
378Your ship is also accessible through its own web interface. Through the web
331−interface you’ll have access to our chat and message boards, the two components
379+interface you'll have access to our chat and message boards, the two components
332−of our "Landscape" feature. This is a user-friendly way to chat with Talk on the
380+of our _Landscape_ feature. This is a user-friendly way to chat with Talk on the
333−Arvo network and access and materials you’ve published on your ship. If You're
381+Arvo network and access and materials you've published on your ship. If You're
334running Arvo locally on your own machine, try opening `http://localhost/` in
382running Arvo locally on your own machine, try opening `http://localhost/` in
335your browser.
383your browser.