1
1
mirror of https://github.com/urbit/shrub.git synced 2024-12-27 06:02:27 +03:00
An operating function (Prototype)
Go to file
2021-04-28 13:18:37 -04:00
.github build: only run publish-npm-packages on pkg/npm 2021-03-30 15:39:41 -04:00
bin glob: update to 0v3.g6u13.haedt.jt4hd.61ek5.6t30q 2021-04-22 18:00:19 +10:00
doc/spec Misc cleanup blocking CC-Release. () 2019-04-24 17:27:27 -07:00
extras Misc cleanup blocking CC-Release. () 2019-04-24 17:27:27 -07:00
nix king: ensure lmdb is statically linked on osx 2021-04-27 19:50:16 +02:00
pkg ChatPane: invert showOurContact conditional 2021-04-28 13:18:37 -04:00
sh demo: add demo/testing agent for hook libraries 2021-03-19 10:12:50 +10: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 king: restore king to rightful place in default.nix 2021-01-25 17:34:46 -08:00
LICENSE.txt Restore toplevel LICENSE.txt file. 2020-01-28 13:24:39 -08:00
MAINTAINERS.md meta: update MAINTAINERS for auto-deploy 2021-01-06 12:34:39 -05:00
Makefile nix: don't install urbit-debug by default. 2020-12-07 10:35:36 -05:00
README.md build: document use of ares.cachix.org in the top-level README 2020-12-14 09:22:40 +01:00
shell.nix hs: remove lmdb-static; just use lmdb 2021-03-22 14:43:43 -04: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

License Build Nix Cachix

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

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

You can optionally setup Nix to pull build artefacts from the binary cache that continuous integration uses. This will improve build times and avoid unnecessary recompilations of common dependencies. Once Nix has been installed you can setup Cachix via:

nix-env -iA cachix -f https://cachix.org/api/v1/install
cachix use ares

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.