mirror of https://github.com/urbit/shrub.git synced 2024-11-24 13:06:09 +03:00

History

bonbud-macryg d639e2d6ea Remove XX about explaining %pro		2024-06-05 14:27:42 +01:00
..
app	neo: improve accel	2024-06-04 10:56:00 -04:00
gen	neo: dependency tracking	2024-05-28 00:43:53 -04:00
lib	neo: rebuild accel rendering	2024-06-04 06:01:03 -04:00
mar	neo: networking	2024-05-27 18:57:58 -04:00
neo/cod/std/src	Remove XX about explaining %pro	2024-06-05 14:27:42 +01:00
sur	neo: rebuild accel rendering	2024-06-04 06:01:03 -04:00
sys	Merge pull request #6839 from will-hanlen/patch-1	2023-11-29 18:47:51 +02:00
ted	neo: minimum viable ford	2024-03-12 15:17:52 -04:00
web	improve sky settings ui	2024-05-27 14:08:48 +02: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
desk.bill	Merge branch 'master' into naive/roller	2021-10-26 20:46:32 +02:00
LICENSE.txt	Pull in latest v0.8.0.rc changes	2019-07-16 15:59:39 -07:00
README.md	%home -> %base	2022-03-06 11:55:55 -05:00
sys.kelvin	gall: implement local provenance	2023-05-23 01:12:09 +12: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 /=base=.

To create a custom pill (bootstrapping object) from the files loaded into the base 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.