@@ -24,15 +24,6 @@ with us at [urbit.org/stream](https://urbit.org/stream).
24> lots of fun to play with, but not quite ready for your important or
24> lots of fun to play with, but not quite ready for your important or
25> sensitive data.
25> sensitive data.
27−### Update: `~2017.12.7`
29−Urbit `0.5.1` is now live! We expect there to be a delay in getting our
30−updated `urbit-0.5.1` binary packages propagated to Homebrew, APT and
31−the other various package managers. So for now, **please build and
32−install Urbit from source**. The instructions below will walk you through
33−how to do that. You'll then be free to continue the boot and setup
34−process as normal, per the rest of this Using docs section.
36## Build from source
27## Build from source
38### Dependencies
29### Dependencies
@@ -40,50 +31,51 @@ process as normal, per the rest of this Using docs section.
40Urbit depends on:
31Urbit depends on:
43−C compiler (gcc or clang)
36+C compiler (gcc or clang)
57Which can usually be installed with the following one-liners:
50Which can usually be installed with the following one-liners:
60−# Mac OS X [Homebrew]
53+# macOS (Homebrew) https://treehouse.github.io/installation-guides/mac/homebrew
54+# Linuxbrew http://linuxbrew.sh/
61−$ brew install gmp libsigsegv openssl libtool autoconf automake cmake
55+$ brew install autoconf automake cmake gcc git gmp libsigsegv libtool python2 openssl
63−# Mac OS X [Macports]
57+# macOS (Macports)
64−$ sudo port install gmp libsigsegv openssl autoconf automake cmake
58+$ sudo port install autoconf automake cmake gmp libsigsegv openssl
66# Ubuntu or Debian
60# Ubuntu or Debian
67−$ sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c libcurl4-gnutls-dev
61+$ sudo apt-get install autoconf automake cmake exuberant-ctags g++ git libcurl4-gnutls-dev libgmp3-dev libncurses5-dev libsigsegv-dev libssl-dev libtool make openssl python ragel re2c zlib1g-dev
70−$ sudo dnf install gcc gcc-c++ gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
64+$ sudo dnf install autoconf automake cmake ctags gcc gcc-c++ git gmp-devel libcurl-devel libsigsegv-devel libtool ncurses-devel openssl openssl-devel python2 ragel re2c
73−$ pkg install gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
67+$ pkg install autoconf automake cmake curl gcc git gmake gmp libsigsegv libtool python ragel re2c
76−$ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
70+$ pacman -S autoconf automake cmake curl gcc git gmp libsigsegv libtool ncurses openssl python ragel re2c
79−$ sudo yum --enablerepo epel install gcc gcc-c++ gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
73+$ sudo yum install --enablerepo epel autoconf automake cmake ctags gcc gcc-c++ git gmp-devel libcurl-devel libsigsegv-devel libtool ncurses-devel openssl-devel python re2c
82### Clone and make
76### Clone and make
84−Once your dependencies are installed the rest is easy.
78+Once your dependencies are installed the rest is easy:
86−If you're cloning the `urbit/urbit` Git repository for the first time, run:
89$ git clone https://github.com/urbit/urbit
81$ git clone https://github.com/urbit/urbit
@@ -91,20 +83,6 @@ $ cd urbit
91$ make # gmake on FreeBSD
83$ make # gmake on FreeBSD
94−_**Updated for the `2017.12.7` continuity breach**_
96−If you already have a clone of the `urbit/urbit` Git repository, assuming
97−your `origin` upstream is the `urbit/urbit` repository on Github, run the
98−following commands to make sure you're on the correct, clean Git branch:
103−$ git checkout master
104−$ git reset --hard origin/master
105−$ make # gmake on FreeBSD
108After running `make`, your Urbit executable is in `bin/urbit`. Install
86After running `make`, your Urbit executable is in `bin/urbit`. Install
109it wherever you'd like.
87it wherever you'd like.
@@ -116,7 +94,51 @@ Test that it works:
119−simple usage:
97+Urbit: a personal server operating function
101+Usage: urbit [options...] ship_name
102+where ship_name is a @p phonetic representation of an urbit address
103+without the leading '~', and options is some subset of the following:
105+-A dir Use dir for initial galaxy sync
107+-B pill Bootstrap from this pill
108+-c pier Create a new urbit in pier/
110+-D Recompute from events
111+-F Fake keys; also disables networking
114+-H domain Set ames bootstrap domain (default urbit.org)
115+-I galaxy Start as ~galaxy
116+-k stage Start at Hoon kernel version stage
117+-l port Initial peer port
119+-n host Set unix hostname
120+-N Enable networking in fake mode (-F)
121+-p ames_port Set the HTTP port to bind to
124+-r host Initial peer address
125+-R Report urbit build info
126+-s Pill URL from arvo git hash
127+-t ticket Use ~ticket automatically
128+-u url URL from which to download pill
130+-w name Immediately upgrade to ~name
132+-Xwtf Skip last event
135+ To create a development ship, use a fakezod:
136+ urbit -FI zod -A /path/to/arvo/folder -B /path/to/pill -c zod
138+ For more information about developing on urbit, see:
139+ https://github.com/urbit/urbit/blob/master/CONTRIBUTING.md
120 urbit -c <mycomet> to create a comet (anonymous urbit)
142 urbit -c <mycomet> to create a comet (anonymous urbit)
121 urbit -w <myplanet> -t <myticket> if you have a ticket
143 urbit -w <myplanet> -t <myticket> if you have a ticket
122 urbit <myplanet or mycomet> to restart an existing urbit
144 urbit <myplanet or mycomet> to restart an existing urbit