From 2a5757ab9df6d013444bf1fa75af764b27417603 Mon Sep 17 00:00:00 2001 From: Joe Bryan Date: Tue, 15 Jan 2019 13:22:47 -0500 Subject: [PATCH] corrects build/dependency sections of README --- README.md | 33 +++++---------------------------- 1 file changed, 5 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 3bb348b97f..0aeeb2ef65 100644 --- a/README.md +++ b/README.md @@ -25,24 +25,22 @@ If you're doing development on Urbit, keep reading. - [libcurl](https://curl.haxx.se/libcurl/) - [libuv](http://libuv.org) - curses implementation (ncurses on Linux distributions, OS curses otherwise) -- [re2c](http://re2c.org) 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. +libsigsegv. ## Building Urbit uses Meson build system. Some libraries which are not found in major distributions: + - ed25519 -- http-parser legacy version 0.1.0 +- libh2o - murmur3 - softfloat3 -- urbit-scrypt -- commonmark legacy version 0.12.0 +- scrypt are included as git submodules. To build urbit from source, perform the following steps: @@ -65,6 +63,7 @@ To set a prefix for installation use ## 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. @@ -73,28 +72,6 @@ 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