1
1
mirror of https://github.com/urbit/shrub.git synced 2024-12-21 18:01:32 +03:00
An operating function (Prototype)
Go to file
2022-04-22 12:26:53 +02:00
.github ci: upgrade cachix/install-nix-action from v13 -> v16 2021-12-08 10:08:59 +01:00
bin pill: solid, brass 2022-02-02 21:06:23 -06: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 [nix] track nixos-21.11 branch whenever niv updates, bump to include qemu-in-virtualization fix 2021-12-16 13:17:04 -06:00
pkg ames: remove sigwut 2022-04-22 12:26:53 +02:00
sh build: remove haskell related nix code and haskell.nix dependency 2021-12-08 10:06:42 +01:00
.eslintrc.js meta: rework precommit linting for multiple packages 2021-07-02 10:40:57 +10:00
.gitattributes meta: enforce LF newlines for all hoon and hoon related files 2021-11-25 10:58:21 -05:00
.gitignore Merge branch 'master' into release/next-vere 2021-10-05 11:33:08 -04: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
.nvmrc deps: peg node version in project root 2022-02-24 16:46:49 -06:00
.stylish-haskell.yaml stylish-haskell 2019-07-12 12:27:15 -07:00
.vercelignore ci: allows us to deploy frontends to vercel 2021-09-15 11:42:22 -05:00
CONTRIBUTING.md readme: update CONTRIBUTING.md 2022-01-04 16:20:29 -05:00
default.nix build: correct lmdb static builds 2021-12-08 16:08:37 +01:00
lerna.json grid: init combination from liam + hunter 2021-08-13 18:11:16 -05:00
LICENSE.txt Restore toplevel LICENSE.txt file. 2020-01-28 13:24:39 -08:00
MAINTAINERS.md repo: minor desk instruction fixes 2022-03-23 16:17:27 -06:00
Makefile nix: don't install urbit-debug by default. 2020-12-07 10:35:36 -05:00
package-lock.json groups: Add fingerprintjs 2022-03-25 14:25:07 -05:00
package.json deps: peg node version in project root 2022-02-24 16:46:49 -06: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 build: remove haskell related nix code and haskell.nix dependency 2021-12-08 10:06:42 +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

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.