mirror of https://github.com/urbit/shrub.git synced 2024-12-21 01:41:37 +03:00

History

Liam Fitzgerald b0bfa500d4 aqua: clarify structure of $vere		2021-06-22 06:13:26 +10:00
..
app	aqua: clarify structure of $vere	2021-06-22 06:13:26 +10:00
gen	ph: migrate tests to new api	2021-06-18 15:54:17 +10:00
lib	aqua: cleanup api, fix scry handling	2021-06-18 15:53:24 +10:00
mar	mar/boot-pill: build mark correctly	2021-06-18 16:53:00 +10:00
sur	aqua: cleanup api, fix scry handling	2021-06-18 15:53:24 +10:00
sys	clay: handle out-of-bounds versions in nako	2021-06-08 15:41:44 -10:00
ted	ph: migrate tests to new api	2021-06-18 15:54:17 +10:00
tests	btc: post merge cleanup	2021-05-26 18:30:17 -07:00
.gitattributes	gitattributes: export-ignore additions [ci skip]	2020-02-01 17:40:27 +04:00
.ignore	Write top-level pier code; hook up Ames and Behn.	2019-07-31 19:34:14 -07:00
LICENSE.txt	Pull in latest v0.8.0.rc changes	2019-07-16 15:59:39 -07:00
README.md	readme: update arvo maintainers list	2021-03-25 23:52:20 +01:00
TESTING.udon	Pull in latest v0.8.0.rc changes	2019-07-16 15:59:39 -07:00

README.md

Arvo

A clean-slate operating system.

Usage

To run Arvo, you'll need Urbit. To install Urbit and run Arvo please follow the instructions in the getting started docs. You'll be on the live network in a few minutes.

If you're doing development on Arvo, keep reading.

Documentation

Find Arvo's documentation on urbit.org.

Development

To boot a fake ship from your development files, run urbit with the following arguments:

urbit -F zod -A /path/to/arvo -c fakezod

Mount Arvo's filesystem allows you to update its contents through Unix. To do so, run |mount in dojo. It is most common to |mount /=home=.

To create a custom pill (bootstrapping object) from the files loaded into the home desk, run .my/pill +solid. Your pill will appear in /path/to/fakezod/.urb/put/my.pill.

To boot a fake ship with a custom pill, use the -B flag:

urbit -F zod -A /path/to/arvo -B /path/to.pill -c fakezod

To run all tests in /tests, run -test %/tests in dojo. To run only the tests in /tests/some/path, use -test %/tests/some/path.

Maintainers

Most parts of Arvo have dedicated maintainers.

/sys/hoon: @pilfer-pandex (~pilfer-pandex)
/sys/zuse: @pilfer-pandex (~pilfer-pandex)
/sys/arvo: @joemfb (~master-morzod)
/sys/vane/ames: @belisarius222 (~rovnys-ricfer) & @philipcmonk (~wicdev-wisryt)
/sys/vane/behn: @belisarius222 (~rovnys-ricfer)
/sys/vane/clay: @philipcmonk (~wicdev-wisryt) & @belisarius222 (~rovnys-ricfer)
/sys/vane/dill: @fang- (~palfun-foslup)
/sys/vane/eyre: @fang- (~palfun-foslup)
/sys/vane/gall: @philipcmonk (~wicdev-wisryt)
/sys/vane/jael: @fang- (~palfun-foslup) & @philipcmonk (~wicdev-wisryt)
/app/acme: @joemfb (~master-morzod)
/app/dns: @joemfb (~master-morzod)
/app/aqua: @philipcmonk (~wicdev-wisryt)
/app/hood: @belisarius222 (~rovnys-ricfer)
/lib/hood/drum: @fang- (~palfun-foslup)
/lib/hood/kiln: @philipcmonk (~wicdev-wisryt)

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.