An operating function (Prototype)
Go to file
Benjamin Summers f8f967e6d4 Tracing cleanup
2019-07-21 13:30:30 -07:00
bin Pull in latest v0.8.0.rc changes 2019-07-16 15:59:39 -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 Pull in latest v0.8.0.rc changes 2019-07-16 15:59:39 -07:00
pkg Tracing cleanup 2019-07-21 13:30:30 -07:00
sh removes brass pill staging from merge builds in CI 2019-07-01 14:16:02 -07:00
.gitattributes Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
.gitignore \#*\#*\#*\#*\#*\#*\#* 2019-05-23 16:58:29 -07:00
.stylish-haskell.yaml stylish-haskell 2019-07-12 12:27:15 -07:00
.travis.yml Get cross-compilation ready for release. (#1263) 2019-05-02 13:13:48 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md. 2019-07-15 08:10:53 -02:30
default.nix Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
Makefile Minor 2019-07-16 16:26:47 -07:00
README.md Add git LFS instructions to README. [ci skip] 2019-06-30 18:42:58 +08:00
stack.yaml Moved language stuff to another branch. 2019-07-16 22:38:35 -07: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

Note that some of the Makefile targets need access to pills tracked via git LFS, so you'll also need to have those available locally:

git lfs install
git lfs pull

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.