ilyakooo0/urbit
1
0
Fork 0
mirror of https://github.com/ilyakooo0/urbit.git synced 2024-09-11 10:46:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
An operating function
15,584 Commits 6 Branches 0 Tags 160 MiB
hoon 44.8%
JavaScript 44.4%
TypeScript 9.8%
CSS 0.3%
Python 0.2%
Other 0.4%
9e3b960194
Go to file
Jared Tobin 9e3b960194
contributing: fix awkward language [ci skip] 
This is more of an OCD fix than anything, but technically the canonical
source tree is not located 'in' the master branch; it *is* the master
branch.
2019-10-06 19:03:26 +04:00
bin Merge branch 'behn-log-drip-fail' (#1795) 2019-10-05 16:28:20 +04: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 Adding conditional gdb/coredump logging for debug images 2019-10-04 22:31:25 +02:00
pkg Merge branch 'tank-priorities' (#1797) 2019-10-06 09:22:57 +04:00
sh build: Tag container images with git branch/sha build information 2019-10-05 11:16:59 -07:00
.gitattributes Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
.gitignore automatically rename minified files 2019-07-24 15:13:21 -07:00
.travis.yml only update cachix if credentials are available 2019-07-15 14:46:36 -07:00
CONTRIBUTING.md contributing: fix awkward language [ci skip] 2019-10-06 19:03:26 +04:00
default.nix Nix Build + Monorepo Structure (#1196) 2019-03-04 16:43:53 -08:00
Makefile added single command to build interface files 2019-07-24 15:14:16 -07:00
README.md readme: point arvo URL at subtree [ci skip] 2019-09-20 12:16:50 -02:30

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: