urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-11-24 04:58:08 +03:00
Code Issues Packages Projects Releases Wiki Activity
An operating function (Prototype)
3,148 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%
35bfb49086
Go to file
Joe Bryan 35bfb49086 Merge branch 'release-candidate' into ames-eth-keys 
* release-candidate: (21 commits)
  zinc gate casting bug
  Bug fix for metal-wrapping runes
  converting iron and zinc cores to lead bug
  8. updates nock 4K spec
  7. updates %5 to require two subformulas (nock 4K)
  6. implements edit at %10 (nock 4K)
  5. removes %13 and %14 (nock 4K)
  4. emits %11 and %12 (nock 4K)
  3. implements hint at %11 and wish at %12 (nock 4K)
  2. removes %10 and %11 (nock 4K)
  1. duplicates hint (%10) and wish (%11) at %13 and %14 (nock 4K)
  Disable terminal echo on passcode entry
  increased inbound request and ward timeouts to 5 min
  mutating edit
  bail in _n_edit on invalid path
  avoid allocating an atom for _cj_bash
  bypass mat and chop directly in jam
  small memory leak for large edits
  disable hike jet, kill errant and unneccessary mutate-context-sample opcodes
  bugfixes
  ...
2018-11-01 00:16:20 -04:00
.d hashtable tests and associated makefile changes 2017-11-09 08:35:05 -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 Merge branch 'release-candidate' into ames-eth-keys 2018-11-01 00:16:20 -04:00
jets Merge branch 'release-candidate' into ames-eth-keys 2018-11-01 00:16:20 -04:00
noun Merge branch 'release-candidate' into ames-eth-keys 2018-11-01 00:16:20 -04:00
scripts Use --buildtype instead of -Dbuildtype 2018-05-29 11:19:55 -07:00
Spec 8. updates nock 4K spec 2018-10-10 20:25:23 -04:00
subprojects upgrades libh2o to v0.13.5 (h2o v2.2.5) 2018-07-19 16:29:01 -04:00
tests _test_cache_replace_value() 2017-11-09 08:35:05 -08:00
vere Merge branch 'release-candidate' into ames-eth-keys 2018-11-01 00:16:20 -04:00
.gitignore Remove deprecated paths from gitignore 2018-07-10 02:07:34 +02:00
.gitmodules adds static libsni (extracted from sniproxy) dependency 2018-06-20 23:39:20 -04: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 adds meson option (-Dprof=true) to set U3_CPU_DEBUG 2018-10-01 19:04:58 -04:00
meson.build adds meson option (-Dprof=true) to set U3_CPU_DEBUG 2018-10-01 19:04:58 -04:00
README.md Revert "Revert "Merge pull request #977 from urbit/meson-build-type"" 2018-05-29 10:55:24 -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 -Dbuildtype=debug. 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: