mirror of https://github.com/urbit/shrub.git synced 2024-12-18 15:55:00 +03:00

History

yosoyubik 9c8080cb0b ames: move peer-state lookups to helper chapter		2023-02-22 09:11:22 +01:00
..
app	Merge branch 'develop' into lf/goerli-address	2023-02-09 06:57:19 -08:00
gen	ames: style fixes and comments	2023-02-14 06:06:41 +01:00
lib	Merge branch 'develop' into jm/desk-scries	2023-02-17 12:00:48 -03:00
mar	Merge branch 'next/arvo' into next/dill	2023-01-03 18:56:33 +01:00
sur	Merge branch 'develop' into lf/goerli-address	2023-02-09 06:57:19 -08:00
sys	ames: move peer-state lookups to helper chapter	2023-02-22 09:11:22 +01:00
ted	Add threads to run arbitrary hoon	2023-02-17 15:39:10 +01: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	kelvin: bump to 139	2023-01-13 16:12:35 -07: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.