urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-11-28 13:54:20 +03:00
Code Issues Packages Projects Releases Wiki Activity
An operating function (Prototype)
2,741 Commits 768 Branches 10 Tags 215 MiB
hoon 80.4%
TypeScript 14.6%
JavaScript 3.2%
CSS 0.6%
Python 0.3%
Other 0.8%
6c36594f6f
Go to file
Joe Bryan 6c36594f6f Merge branch 'master' into libh2o 
* master: (124 commits)
  use compile-time assertion to check for unsigned char
  Don't build libuv in travis if it is now submoduled.
  Rebuild the scripts without PKG_CONFIG_PATH hacks.
  Remove manual PKG_CONFIG_PATH configuration.
  Enable fallback libuv bundle
  Bundle libuv.
  adds a cell check for the sample of the +roll gate
  Add missing flags fixing the markdown parser bug #951
  Revert "Merge pull request #952 from eglaysher/revert-meson"
  Revert "Merge pull request #949 from eglaysher/meson-build-clean"
  Revert "The -C flag was added for exactly this case."
  The -C flag was added for exactly this case.
  Take ownership of the submodule repositories.
  Revert "Revert "Merge pull request #941 from frodwith/runtime-overflows""
  Add legacy meson instructions to README
  Fix new meson version check
  Fix legacy meson version detection.
  Universal meson build.
  change overflow check to short
  do the don trick for jam
  ...
2018-04-09 19:49:40 -07:00
.d hashtable tests and associated makefile changes 2017-11-09 08:35:05 -08:00
debian Revert "Merge pull request #952 from eglaysher/revert-meson" 2018-03-20 10:16:16 -07:00
extras Improve sublime arm name indexing. 2015-11-16 18:15:32 -05:00
include Merge branch 'master' into libh2o 2018-04-09 19:49:40 -07:00
jets Merge pull request #953 from eglaysher/reapply-meson 2018-04-09 19:14:55 -07:00
noun change overflow check to short 2018-03-15 16:58:04 -07:00
scripts Rebuild the scripts without PKG_CONFIG_PATH hacks. 2018-04-03 11:15:17 -07:00
Spec Typo in 4k Nock spec 2018-02-14 13:57:56 -06:00
subprojects Bundle libuv. 2018-04-03 10:31:53 -07:00
tests _test_cache_replace_value() 2017-11-09 08:35:05 -08:00
vere Merge branch 'master' into libh2o 2018-04-09 19:49:40 -07:00
.gitignore Revert "Merge pull request #952 from eglaysher/revert-meson" 2018-03-20 10:16:16 -07:00
.gitmodules Bundle libuv. 2018-04-03 10:31:53 -07:00
.travis.yml Don't build libuv in travis if it is now submoduled. 2018-04-03 11:23:00 -07:00
CONTRIBUTING.md Updates contributor guidelines 2016-10-27 13:02:43 -04: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 Revert "Merge pull request #952 from eglaysher/revert-meson" 2018-03-20 10:16:16 -07:00
meson.build Remove manual PKG_CONFIG_PATH configuration. 2018-04-03 11:05:41 -07:00
README.md Rebuild the scripts without PKG_CONFIG_PATH hacks. 2018-04-03 11:15:17 -07: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 project, enter the build directory and enter meson configure. Without any arguments this command will display available options. For example, to compile debug build of urbit, use meson configure -Ddebug=true. To set the prefix for installation use meson configure -Dprefix=/usr, and so on.

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: