mirror of https://github.com/urbit/shrub.git synced 2024-12-28 22:54:15 +03:00

History

Ted Blackman 174f36f1a8 aqua/ph: fix comet test		2020-12-01 09:59:07 -05:00
..
app	various: touch up improperly rewritten comments	2020-11-27 13:25:40 +01:00
gen	Merge branch 'm/vane-unversion' into m/modern-hoon	2020-11-30 21:04:16 -08:00
lib	hood: fix obsolete syntax introduced in merge	2020-11-30 21:23:35 -08:00
mar	various: touch up improperly rewritten comments	2020-11-27 13:25:40 +01:00
sur	various: move away from {type} syntax	2020-11-26 17:43:26 +01:00
sys	ames: flat packet format	2020-12-01 09:51:14 -05:00
ted	aqua/ph: fix comet test	2020-12-01 09:59:07 -05:00
tests	ames: flat packet format	2020-12-01 09:51:14 -05: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: improve clarity of phrasing around testing	2020-09-28 18:49:37 +02: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: @joemfb (~master-morzod)
/sys/vane/eyre: @eglaysher (~littel-ponnys)
/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: @philipcmonk (~wicdev-wisryt)
/lib/hood/kiln: @philipcmonk (~wicdev-wisryt)
/lib/test: @eglaysher (~littel-ponnys)

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.