urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-12-23 19:05:48 +03:00
Code Issues Packages Projects Releases Wiki Activity
An operating function (Prototype)
17,013 Commits 768 Branches 10 Tags 215 MiB
hoon 80.4%
TypeScript 14.6%
JavaScript 3.2%
CSS 0.6%
Python 0.3%
Other 0.8%
45af92c173
Go to file
Matilde Park 45af92c173 publish: sidebar and note -m, -l viewport fixes
2020-02-20 00:28:16 -05:00
bin pills: updated all 2020-02-07 16:20:15 -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 build: allow baking multiple pills into docker images 2019-12-18 12:02:18 +01:00
pkg publish: sidebar and note -m, -l viewport fixes 2020-02-20 00:28:16 -05:00
sh updated sh/build-interface 2020-02-14 17:06:20 -08:00
.gitattributes apps: designate compiled js/css files as binary 2019-11-05 11:52:58 +08:00
.gitignore link: add minimal link-server-hook and link-webext 2019-12-11 20:49:50 +01:00
.mailmap meta: update .mailmap [ci skip] 2019-12-19 08:49:40 -03:30
.travis.yml ci: remove whitespace test [ci skip] 2020-01-14 11:30:00 -08:00
CONTRIBUTING.md contributing: use alternative rebase tutorial [ci skip] 2019-12-18 08:29:22 -03:30
default.nix Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
MAINTAINERS.md meta: add a basic maintainers' guide [ci skip] 2019-12-21 13:44:01 -03:30
Makefile build: add ropsten-pills target to Makefile 2019-10-24 10:03:52 +08:00
README.md readme: update bridge URL [ci skip] 2020-01-23 04:38:27 +04:00

README.md

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! Please take a look at our contributing guidelines for details on our git practices, coding styles, how we manage issues, and so on.

You might also be interested in: