on master help sign in
Update /docs/using/install doc
commit28ed8bcf081defd60bb40b873df01308b7fb7d55 authorKeaton Dunsford <keaton@tlon.io> dateThu 8 Mar 2018, 15:06 (9 years ago) parent05fd35f
1 file changed+64−42
docs/using/install.md+64−42
docs/using/install.md+64−42
@@ -24,15 +24,6 @@ with us at [urbit.org/stream](https://urbit.org/stream).
2424> lots of fun to play with, but not quite ready for your important or
2525> sensitive data.
2626
27−### Update: `~2017.12.7`
28−
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.
35−
3627## Build from source
3728
3829### Dependencies
@@ -40,50 +31,51 @@ process as normal, per the rest of this Using docs section.
4031Urbit depends on:
4132
4233```
43−C compiler (gcc or clang)
44−automake
4534autoconf
46−libtool
35+automake
36+C compiler (gcc or clang)
4737cmake
48−ragel
49−re2c
50−libcurl
5138curses
39+git
5240gmp
41+libcurl
5342libsigsegv
43+libtool
5444openssl
45+python2
46+ragel
47+re2c
5548```
5649
5750Which can usually be installed with the following one-liners:
5851
5952```
60−# Mac OS X [Homebrew]
61−$ brew install gmp libsigsegv openssl libtool autoconf automake cmake
53+# macOS (Homebrew) https://treehouse.github.io/installation-guides/mac/homebrew
54+# Linuxbrew http://linuxbrew.sh/
55+$ brew install autoconf automake cmake gcc git gmp libsigsegv libtool python2 openssl
6256
63−# Mac OS X [Macports]
64−$ sudo port install gmp libsigsegv openssl autoconf automake cmake
57+# macOS (Macports)
58+$ sudo port install autoconf automake cmake gmp libsigsegv openssl
6559
6660# 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
6862
6963# Fedora
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
7165
7266# FreeBSD
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
7468
7569# Arch
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
7771
7872# AWS
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
8074```
8175
8276### Clone and make
8377
84−Once your dependencies are installed the rest is easy.
85−
86−If you're cloning the `urbit/urbit` Git repository for the first time, run:
78+Once your dependencies are installed the rest is easy:
8779
8880```
8981$ git clone https://github.com/urbit/urbit
@@ -91,20 +83,6 @@ $ cd urbit
9183$ make # gmake on FreeBSD
9284```
9385
94−_**Updated for the `2017.12.7` continuity breach**_
95−
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:
99−
100−```
101−$ cd urbit
102−$ git fetch --all
103−$ git checkout master
104−$ git reset --hard origin/master
105−$ make # gmake on FreeBSD
106−```
107−
10886After running `make`, your Urbit executable is in `bin/urbit`. Install
10987it wherever you'd like.
11088
@@ -116,7 +94,51 @@ Test that it works:
11694
11795```
11896$ urbit
119−simple usage:
97+Urbit: a personal server operating function
98+https://urbit.org
99+Version 0.5.1
100+
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:
104+
105+-A dir Use dir for initial galaxy sync
106+-b Batch create
107+-B pill Bootstrap from this pill
108+-c pier Create a new urbit in pier/
109+-d Daemon mode
110+-D Recompute from events
111+-F Fake keys; also disables networking
112+-f Fuzz testing
113+-g Set GC flag
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
118+-M Memory madness
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
122+-P Profiling
123+-q Quiet
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
129+-v Verbose
130+-w name Immediately upgrade to ~name
131+-x Exit immediately
132+-Xwtf Skip last event
133+
134+Development Usage:
135+ To create a development ship, use a fakezod:
136+ urbit -FI zod -A /path/to/arvo/folder -B /path/to/pill -c zod
137+
138+ For more information about developing on urbit, see:
139+ https://github.com/urbit/urbit/blob/master/CONTRIBUTING.md
140+
141+Simple Usage:
120142 urbit -c <mycomet> to create a comet (anonymous urbit)
121143 urbit -w <myplanet> -t <myticket> if you have a ticket
122144 urbit <myplanet or mycomet> to restart an existing urbit