ilyakooo0/urbit
1
0
Fork 0
mirror of https://github.com/ilyakooo0/urbit.git synced 2024-12-16 19:22:22 +03:00
Code Issues Packages Projects Releases Wiki Activity
An operating function
3,414 Commits 6 Branches 0 Tags 164 MiB
hoon 79.3%
TypeScript 16.7%
JavaScript 2.3%
CSS 0.4%
Python 0.4%
Other 0.8%
114deafd54
Go to file
Jōshin 114deafd54 Fix build on OSX with MacPorts 
MacPorts OpenSSL seems to include a proper pkgconfig file, so the
openssl dependency just works. N.B. I haven't tested this on a
homebrew system yet.

I also added a note to set LIBRARY_PATH=/opt/local to pick up gmp and
libsigsegv. An alternative would be to specify dirs: ['/opt/local/lib',
'/usr/local/lib'] on each of them.
2019-01-02 21:31:55 -08:00
.travis [CI] Update arvo 2018-12-13 11:06:07 -08:00
debian Bump Vere version to version 0.6.0 2018-06-08 14:31:42 -07:00
extras Improve sublime arm name indexing. 2015-11-16 18:15:32 -05:00
include Clean up allocator defs 2019-01-02 11:23:06 -08:00
jets Add jet for +del:in 2018-12-13 14:39:53 -08:00
noun don't abort on bail:fail, but continue with crash handling 2018-12-13 23:26:17 -05:00
scripts [build] builds just the urbit binary by default 2018-11-26 16:40:43 -05:00
Spec 8. updates nock 4K spec 2018-10-10 20:25:23 -04:00
subprojects meson cleanup 2019-01-02 21:31:55 -08:00
tests removes old kjet implementation file 2018-11-13 13:43:51 -05:00
vere Clean up allocator defs 2019-01-02 11:23:06 -08:00
.gitignore secp256 jetted 2018-08-07 15:16:48 -04:00
.gitmodules removes commonmark and the markdown jet 2018-12-10 16:03:37 -05:00
.travis.yml [CI] skip arvo download, retrieve pill directly 2018-12-04 03:31:16 -05:00
CONTRIBUTING.md updates fake-zod examples, removing -I 2018-11-01 00:43:09 -04:00
default.nix Use fetchGit instead of fetchTarball to get nixpkgs. 2018-11-14 09:47:28 -08:00
gdb-test-hash gdb script for testing 2017-11-09 08:35:05 -08:00
LICENSE.txt MIT LICENSE 2015-02-10 12:19:37 -08:00
meson_options.txt renames event-timing, adds build option to enable 2018-12-13 20:03:19 -05:00
meson.build Fix build on OSX with MacPorts 2019-01-02 21:31:55 -08:00
README.md Fix README build instructions 2018-11-15 19:39:32 -05:00

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

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

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)

  1. Install all required dependencies.
  2. Run ./scripts/bootstrap
  3. Run ./scripts/build
  4. The executable should appear in ./build directory.

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.

  1. Manually create build directory and invoke meson as meson . ./build
  2. If you want to set options, this is done in one step. Use meson -D [options] . ./build to 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 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: