An operating function (Prototype)
Go to file
Joe Bryan aa05514625 Merge branch 'cc-release-prepare-args' into cc-release-rc-merge
* cc-release-prepare-args:
  adds placeholder for -J (ivory pill, unimplemented)
  alphebetizes u3_opts and _main_getopt() defaults
  replaces -k with -K (kernel version)
  renames -L (local networking) from loh to net
  removes -t (ticket), -s, and -S (secret/prompt)
  removes unused args -I (galaxy) and -l (raft port)
  removes -n ("unix hostname", for raft)
  removes -X ("skip last event")
  removes -M ("memory madness")
2018-11-16 20:30:16 -05:00
.d Link Murmur3 reference implementation into binary 2016-07-26 17:29:56 -07:00
extras Improve sublime arm name indexing. 2015-11-16 18:15:32 -05:00
include alphebetizes u3_opts and _main_getopt() defaults 2018-11-16 19:28:29 -05:00
jets 4. enables and updates scrypt jet 2018-11-10 22:05:36 -05:00
meson-scripts 3. runs with meson built binary 2018-11-10 22:05:36 -05:00
noun removes u3_lo declarations 2018-11-15 01:42:07 -05:00
scripts 3. runs with meson built binary 2018-11-10 22:05:36 -05:00
Spec Use assumed-secure for the "secure" port 2016-12-12 14:39:56 -08:00
subprojects 4. enables and updates scrypt jet 2018-11-10 22:05:36 -05:00
tests descriptive names for c files 2015-06-23 21:29:11 -04:00
vere adds placeholder for -J (ivory pill, unimplemented) 2018-11-16 20:11:02 -05:00
.gitignore 2. builds with meson 2018-11-10 22:05:28 -05:00
.gitmodules 4. enables and updates scrypt jet 2018-11-10 22:05:36 -05:00
.travis.yml pull libuv1 from future (16.04 rather than 12.04) 2017-06-13 19:26:49 -07:00
CONTRIBUTING.md Updates contributor guidelines 2016-10-27 13:02:43 -04:00
LICENSE.txt MIT LICENSE 2015-02-10 12:19:37 -08:00
meson.build removes batz 2018-11-15 01:42:14 -05:00
README.md add basic .travis.yml 2017-06-13 19:19:39 -07:00

Install instructions

To install and run Urbit please follow the instructions at urbit.org/docs/using/install. Packages and source tarballs are available there. You'll be on the live network in a few minutes.

If you're doing development on Urbit, keep reading.

Build instructions

Build Status

External dependencies

vere, the Urbit virtual machine, depends on the following:

Most of these dependencies are unfortunate; we aim to drastically shrink the list in upcoming versions. vere proper makes use of GMP, OpenSSL, libcurl, and libsigsegv. The multiple build tools are a result of bundled libraries, slated for future unbundling or removal wherever possible.

Building

Our Makefile should handle the build smoothly on all supported platforms. It's just a simple Makefile, written by hand for GNU Make, and the most complicated parts of its internal machinery have to do with the varied build systems of the bundled libraries.

Useful targets are the default all, clean, and distclean. The last may not produce an entirely clean distribution directory, and runs a bundled library's configure script; git clean may be a better option.

The vere binary is produced in bin/urbit.

Contact

If you have any questions, problems, patches, or proposals for patches, please feel free to get in touch in whatever way is most convenient: