|
|
||
|---|---|---|
| .travis | ||
| debian | ||
| extras | ||
| include | ||
| jets | ||
| noun | ||
| scripts | ||
| Spec | ||
| subprojects | ||
| tests | ||
| vere | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| default.nix | ||
| gdb-test-hash | ||
| LICENSE.txt | ||
| meson_options.txt | ||
| meson.build | ||
| 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
- libuv
- curses implementation (ncurses on Linux distributions, OS curses otherwise)
- 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:
Configuration & compilation
(For instructions for legacy meson, also see below)
- Install all required dependencies.
- Run
./scripts/bootstrap - Run
./scripts/build - The executable should appear in
./builddirectory.
Using meson & ninja
To configure the project, enter the build directory and enter
meson configure -Dbuildtype=release. To compile a debug build of urbit, use
meson configure -Dbuildtype=debug.
To set a prefix for installation use
meson configure -Dprefix=/usr.
Configuration & compilation for legacy meson
The syntax for legacy meson (Version 0.29) is a bit different.
- Manually create
builddirectory and invoke meson asmeson . ./build - If you want to set options, this is done in one step.
Use
meson -D [options] . ./buildto prepare customized build.
Once the project is configured, use ninja to build it.
To install it into the default prefix, use ninja install.
If you want to specify custom DESTDIR, use DESTDIR=... ninja install.
Building the Debian Package
To build a .deb file for installation on Debian platforms, perform the following steps:
- Run
sudo apt install devscriptsto install thedebuildutility. - Update the
debian/changelogto reflect the changes in this release. - If necessary, update the year of the copyright in
debian/copyright. - Clean any build artifacts: Run
make cleanand delete thebindirectory, 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.debto install the new version. - Boot up a ship using the
urbitcommand.
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-metaon 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.