mirror of
https://github.com/ilyakooo0/urbit.git
synced 2024-09-11 10:46:43 +03:00
Update README for 0.8.0 release. [ci skip]
This commit is contained in:
parent
2a9808ea99
commit
c4de7c1c34
108
README.md
108
README.md
@ -1,79 +1,65 @@
|
||||
> The Urbit address space is now live on the Ethereum blockchain. We’re calling it ‘Azimuth’ and you can find it at [`0x223c067f8cf28ae173ee5cafea60ca44c335fecb`](https://etherscan.io/address/0x223c067f8cf28ae173ee5cafea60ca44c335fecb) or [`azimuth.eth`](https://etherscan.io/address/azimuth.eth). Owners of Azimuth ‘points’ (galaxies, stars or planets) can use [Bridge](https://github.com/urbit/bridge/releases) to manage them and view their balance now. Sometime in the next few days, owners of Azimuth points will be able to boot Arvo, the Urbit OS, from their Azimuth point and request access to one of our ‘cities’: private communities for chat and discussion. These new cities use Landscape, a brand new UI for using Urbit in the browser.
|
||||
# Urbit
|
||||
|
||||
# Install instructions
|
||||
> The Urbit address space, Azimuth, is now live on the Ethereum blockchain. You
|
||||
> can find it at [`0x223c067f8cf28ae173ee5cafea60ca44c335fecb`][azim] or
|
||||
> [`azimuth.eth`][aens]. Owners of Azimuth points (galaxies, stars, or planets)
|
||||
> can view or manage them using [Bridge][brid], and can also use them to boot
|
||||
> [Arvo][arvo], the Urbit OS.
|
||||
|
||||
[azim]: https://etherscan.io/address/0x223c067f8cf28ae173ee5cafea60ca44c335fecb
|
||||
[aens]: https://etherscan.io/address/azimuth.eth
|
||||
[brid]: https://github.com/urbit/bridge/releases
|
||||
[arvo]: https://github.com/urbit/arvo/
|
||||
|
||||
## Install instructions
|
||||
|
||||
To install and run Urbit please follow the instructions at
|
||||
[urbit.org/docs/getting-started/](https://urbit.org/docs/getting-started/).
|
||||
Packages and source tarballs are available there. You'll be on the live network
|
||||
in a few minutes.
|
||||
[urbit.org/docs/getting-started/][start]. 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.
|
||||
[start]: https://urbit.org/docs/getting-started/
|
||||
|
||||
# Build instructions
|
||||
## Build instructions
|
||||
|
||||
[![Build Status](https://travis-ci.org/urbit/urbit.svg?branch=master)](https://travis-ci.org/urbit/urbit)
|
||||
[![Build Status](https://travis-ci.org/urbit/urbit.svg?branch=master)][trav]
|
||||
|
||||
## External dependencies
|
||||
Urbit uses [Nix][nix] to manage builds. On Linux and OS X you can install Nix
|
||||
via:
|
||||
|
||||
`vere`, the Urbit virtual machine, depends on the following:
|
||||
```
|
||||
curl https://nixos.org/nix/install | sh
|
||||
```
|
||||
|
||||
- C compiler ([gcc](https://gcc.gnu.org) or [clang](http://clang.llvm.org))
|
||||
- [Meson](http://mesonbuild.com/)
|
||||
- [GMP](https://gmplib.org)
|
||||
- [OpenSSL](https://www.openssl.org)
|
||||
- [libsigsegv](https://www.gnu.org/software/libsigsegv/)
|
||||
- [libcurl](https://curl.haxx.se/libcurl/)
|
||||
- [libuv](http://libuv.org)
|
||||
- curses implementation (ncurses on Linux distributions, OS curses otherwise)
|
||||
Given a Nix installation, you can build Urbit with a simple:
|
||||
|
||||
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.
|
||||
```
|
||||
nix-build -A urbit --no-out-link
|
||||
```
|
||||
|
||||
## Building
|
||||
The Makefile in the project's root directory contains several useful phony
|
||||
targets for building, installing, testing, and so on.
|
||||
|
||||
Urbit uses Meson build system.
|
||||
[trav]: https://github.com/urbit/urbit.git
|
||||
[nix]: https://nixos.org/nix/
|
||||
|
||||
Some libraries which are not found in major distributions:
|
||||
## Contributing
|
||||
|
||||
- ed25519
|
||||
- libh2o
|
||||
- murmur3
|
||||
- softfloat3
|
||||
- scrypt
|
||||
Contributions of any form are more than welcome! If something doesn't seem
|
||||
right, and there is no issue about it yet, feel free to open one.
|
||||
|
||||
are included as git submodules. To build urbit from source, perform the following steps:
|
||||
If you're looking to get involved, there are a few things you can do:
|
||||
|
||||
## Configuration & compilation
|
||||
(For instructions for legacy meson, also see below)
|
||||
- Join the [urbit-dev][list] mailing list.
|
||||
- [Ask us about Hoon School][mail], a course we run to teach the Hoon
|
||||
programming language and Urbit application development.
|
||||
- Check out [good contributor issues][good].
|
||||
- Reach out to [support@urbit.org][mail] to say hi and ask any questions you
|
||||
might have.
|
||||
|
||||
1. Install all required dependencies.
|
||||
2. Run `./scripts/bootstrap`
|
||||
3. Run `./scripts/build`
|
||||
4. The executable should appear in `./build` directory.
|
||||
Once you've got your bearings, have a look at [CONTRIBUTING.md][cont] for some
|
||||
pointers on setting up your development environment.
|
||||
|
||||
### 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`.
|
||||
|
||||
## Contact
|
||||
|
||||
We are using our new UI, Landscape to run a few experimental cities.
|
||||
If you have an Azimuth point, please send us your planet name at
|
||||
[support@urbit.org](mailto:support@urbit.org) to request access.
|
||||
[list]: https://groups.google.com/a/urbit.org/forum/#!forum/dev
|
||||
[mail]: mailto:support@urbit.org
|
||||
[good]: https://github.com/urbit/urbit/labels/good%20contributor%20issue
|
||||
[cont]: https://github.com/urbit/urbit/blob/master/CONTRIBUTING.md
|
||||
|
Loading…
Reference in New Issue
Block a user