|
|
||
|---|---|---|
| bin | ||
| doc/spec | ||
| extras | ||
| nix | ||
| pkg | ||
| sh | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| default.nix | ||
| Makefile | ||
| 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
0x223c067f8cf28ae173ee5cafea60ca44c335fecborazimuth.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
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:
- Join the urbit-dev mailing list.
- Apply to Hoon School, a course we run to teach the Hoon programming language and Urbit application development.
- Check out good contributor issues.
Once you've got your bearings, have a look at CONTRIBUTING.md for some pointers on setting up your development environment.