on master help sign in
Quick update to install.md for urbit 0.4
e51a4c0Raymond Pasco
docs/using/install.md+35−25
@@ -14,8 +14,30 @@ Urbit is alpha software. It’s not yet completely stable, its crypto hasn’t
14been audited, and there are plenty of rough edges. Urbit is lots of fun to play
14been audited, and there are plenty of rough edges. Urbit is lots of fun to play
15with, but not quite ready for your important or sensitive data.
15with, but not quite ready for your important or sensitive data.
16
16
17+### Setting up swap
18+
19+Urbit wants to map 2GB of memory when it boots up. We won’t
20+necessarily use all this memory, we just want to see it. On a
21+normal modern PC or Mac, this is not an issue. On some small
22+cloud virtual machines (Amazon or Digital Ocean), the default
23+memory configuration is smaller than this, and you need to
24+manually configure a swapfile.
25+
26+Digital Ocean has a post on adding swap [here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04). For Amazon there’s a StackOverflow thread [here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
27+
28+Don’t spend a lot of time tweaking these settings; the simplest
29+thing is fine.
30+
31+## Install a package
32+
33+Urbit may be in your system's package repository - check there first. If not, we host packages for some platforms:
34+
35+[FreeBSD](https://media.urbit.org/dist/freebsd/urbit-0.4.txz): install with `pkg install urbit-0.4.txz`.
36+
17## Build from source
37## Build from source
18
38
39+First, fetch the source tarball from [here](https://media.urbit.org/dist/src/urbit-0.4.tar.gz).
40+
19### Dependencies
41### Dependencies
20
42
21Urbit depends on:
43Urbit depends on:
@@ -36,46 +58,34 @@ Urbit depends on:
36Which can usually be installed with the following one-liners:
58Which can usually be installed with the following one-liners:
37
59
38 # Mac OS X [Homebrew]
60 # Mac OS X [Homebrew]
39− brew install git gmp libsigsegv openssl libtool autoconf automake cmake
61+ $ brew install git gmp libsigsegv openssl libtool autoconf automake cmake
40
62
41 # Mac OS X [Macports]
63 # Mac OS X [Macports]
42− sudo port install git gmp libsigsegv openssl autoconf automake cmake
64+ $ sudo port install git gmp libsigsegv openssl autoconf automake cmake
43
65
44 # Ubuntu or Debian
66 # Ubuntu or Debian
45− sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c libcurl4-gnutls-dev
67+ $ sudo apt-get install libgmp3-dev libsigsegv-dev openssl libssl-dev libncurses5-dev git make exuberant-ctags automake autoconf libtool g++ ragel cmake re2c libcurl4-gnutls-dev
46
68
47 # Fedora
69 # Fedora
48− sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
70+ $ sudo dnf install gcc gcc-c++ git gmp-devel openssl-devel openssl ncurses-devel libsigsegv-devel ctags automake autoconf libtool ragel cmake re2c libcurl-devel
49
71
50 # FreeBSD
72 # FreeBSD
51− pkg install git gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
73+ $ pkg install git gmake gmp libsigsegv curl python automake autoconf ragel cmake re2c libtool curl
52
74
53 # Arch
75 # Arch
54− pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
76+ $ pacman -S gcc gmp libsigsegv openssl automake autoconf ragel cmake re2c libtool ncurses curl
55
77
56 # AWS
78 # AWS
57− sudo yum —enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
79+ $ sudo yum —enablerepo epel install gcc gcc-c++ git gmp-devel openssl-devel ncurses-devel libsigsegv-devel ctags automake autoconf libtool cmake re2c libcurl-devel
58−
59−### Setting up swap
60−
61−Urbit wants to map 2GB of memory when it boots up. We won’t
62−necessarily use all this memory, we just want to see it. On a
63−normal modern PC or Mac, this is not an issue. On some small
64−cloud virtual machines (Amazon or Digital Ocean), the default
65−memory configuration is smaller than this, and you need to
66−manually configure a swapfile.
67−
68−Digital Ocean has a post on adding swap [here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04). For Amazon there’s a StackOverflow thread [here](http://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).
69−
70−Don’t spend a lot of time tweaking these settings; the simplest
71−thing is fine.
72
80
73### Clone and make
81### Clone and make
74
82
75Once your dependencies are installed the rest is easy:
83Once your dependencies are installed the rest is easy:
76
84
77− git clone https://github.com/urbit/urbit
85+ $ tar xfvz urbit-0.4.tar.gz
78− cd urbit
86+ $ cd urbit-0.4
79− make
87+ $ make # gmake on FreeBSD
88+
89+After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
80
90
81−After running `make`, your Urbit executable lives at `bin/urbit`.
91+ # sudo install -m 0755 bin/urbit /usr/local/bin