shrub/README.md

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

External dependencies

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

• C compiler (gcc or clang)
• Meson
• GMP
• OpenSSL
• libsigsegv
• libcurl
• commonmark
• curses implementation (ncurses on Linux distributions, OS curses otherwise)
• Ragel
• re2c

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

Urbit uses Meson build system.

Some libraries which are not found in major distributions:

• ed25519
• http-parser legacy version 0.1.0
• murmur3
• softfloat3
• urbit-scrypt
• commonmark legacy version 0.12.0

are included as git submodules. To build urbit from source, perform the following steps:

1. Install all required dependencies.
2. git submodule init in the urbit repository
3. git submodule update
4. meson build
5. If the last step was successful, type cd ./build followed by ninja to compile urbit.
6. The executable should appear in ./build directory.

Building the Debian Package

To build a .deb file for installation on Debian platforms, perform the following steps:

• Run sudo apt install devscripts to install the debuild utility.
• Update the debian/changelog to reflect the changes in this release.
• If necessary, update the year of the copyright in debian/copyright.
• Clean any build artifacts: Run make clean and delete the bin directory, if it exists.
• Run tar -xcvf ../urbit-x.y.z.orig.tar.gz . from the top-level folder in the repo. This command will create an archive in the directory above the current directory, which will be used in packaging.
• Run debuild -us -uc, also from the top-level folder in the repo. This creates a .deb file in the folder above the current directory.

The resulting .deb file should now exist in the folder above the current directory. To test that the .deb file works properly, you can perform the following steps:

• Uninstall urbit: sudo apt remove urbit.
• Run sudo dpkg -i ../urbit-x.y.z_amd64.deb to install the new version.
• Boot up a ship using the urbit command.

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:

• Post to /urbit-meta on Urbit :talk. (You can do this via urbit.org/stream without a running Urbit).
• Post to urbit.org/fora.
• Email us directly questions@urbit.org.