An operating function (Prototype)
Go to file
2019-06-28 16:43:52 -07:00
bin updates arvo and pill to 'monorepo-candidate' 2019-06-27 18:05:17 -07:00
doc/spec Misc cleanup blocking CC-Release. (#1249) 2019-04-24 17:27:27 -07:00
extras Misc cleanup blocking CC-Release. (#1249) 2019-04-24 17:27:27 -07:00
nix adds ge-additions package to urbit nix-shell config 2019-06-28 11:37:18 -07:00
pkg clay, alef, and zuse compile 2019-06-28 16:43:52 -07:00
sh Get cross-compilation ready for release. (#1263) 2019-05-02 13:13:48 -07:00
.gitattributes Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
.gitignore Get cross-compilation ready for release. (#1263) 2019-05-02 13:13:48 -07:00
.travis.yml Get cross-compilation ready for release. (#1263) 2019-05-02 13:13:48 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md. [ci skip] 2019-06-17 18:44:08 +08:00
default.nix Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
Makefile adds "make pills" target 2019-05-09 00:32:51 -07:00
README.md s/OS X/macOS 2019-06-17 20:21:02 +08:00

Urbit

A personal server operating function.

The Urbit address space, Azimuth, is now live on the Ethereum blockchain. You can find it at 0x223c067f8cf28ae173ee5cafea60ca44c335fecb or azimuth.eth. Owners of Azimuth points (galaxies, stars, or planets) can view or manage them using Bridge, and can also use them to boot Arvo, the Urbit OS.

Install

To install and run Urbit, please follow the instructions at urbit.org/docs/getting-started/. You'll be on the live network in a few minutes.

If you're interested in Urbit development, keep reading.

Development

Build Status

Urbit uses Nix to manage builds. On Linux and macOS you can install Nix via:

curl https://nixos.org/nix/install | sh

The Makefile in the project's root directory contains useful phony targets for building, installing, testing, and so on. You can use it to avoid dealing with Nix explicitly.

To build Urbit, for example, use:

make build

The test suite can similarly be run via a simple:

make test

Contributing

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.

If you're looking to get involved, there are a few things you can do:

Once you've got your bearings, have a look at CONTRIBUTING.md for some pointers on setting up your development environment.