An operating function (Prototype)
Go to file
Joe Bryan f2a2d174e9
Merge pull request #4027 from urbit/eg/hs-vere-versions
king: port the new lmdb event log changes.
2020-12-04 15:18:27 -08:00
.github build: update gcloud to use non-deprecated action 2020-11-20 07:47:04 +01:00
bin pill: all 2020-11-23 23:26:30 -08: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 nix: trims trailing whitespace from solid pill builder 2020-11-20 15:23:56 -08:00
pkg Merge pull request #4027 from urbit/eg/hs-vere-versions 2020-12-04 15:18:27 -08:00
sh build: simplify make test and re-enable on darwin ci for testing 2020-10-29 13:17:05 +01:00
.gitattributes meta: do not treat arvo JS files as binary 2020-10-08 13:08:00 +10:00
.gitignore build: reorganising top-level .gitignore and add nix ignores 2020-10-27 14:28:07 +01:00
.ignore Can now |hi to King Haskell over Ames! (and merged Master) 2019-07-31 22:16:02 -07:00
.mailmap mailmap: add pkova [ci skip] 2020-01-30 15:53:19 +04:00
.stylish-haskell.yaml stylish-haskell 2019-07-12 12:27:15 -07:00
CONTRIBUTING.md meta: add dev ship instructions from master 2020-09-28 21:58:35 -04:00
default.nix nix: run tests against the latest arvo source 2020-11-20 15:21:50 -08:00
LICENSE.txt Restore toplevel LICENSE.txt file. 2020-01-28 13:24:39 -08:00
MAINTAINERS.md MAINTAINERS: update for versioned JS bundles 2020-08-03 10:15:21 +10:00
Makefile build: simplify make test and re-enable on darwin ci for testing 2020-10-29 13:17:05 +01:00
README.md README: general legibility changes 2020-08-31 21:35:04 -04:00
shell.nix build: github actions workflow configuration 2020-11-15 15:05:13 +01:00

Urbit

Urbit is a personal server stack built from scratch. It has an identity layer (Azimuth), virtual machine (Vere), and operating system (Arvo).

A running Urbit "ship" is designed to operate with other ships peer-to-peer. Urbit is a general-purpose, peer-to-peer computer and network.

This repository contains:

For more on the identity layer, see Azimuth. To manage your Urbit identity, use Bridge.

Install

To install and run Urbit, please follow the instructions at urbit.org/using/install. 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 -L 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 the Urbit virtual machine binary, 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! Please take a look at our contributing guidelines for details on our git practices, coding styles, how we manage issues, and so on.

For instructions on contributing to Landscape, see its guidelines.

You might also be interested in joining the urbit-dev mailing list.