mirror of https://github.com/urbit/shrub.git synced 2024-12-14 11:08:45 +03:00

History

Jared Tobin 8920bf0dc5 meta: update contributing section in arvo readme [ci skip] The subtree in pkg/arvo apparently still has a README in it, which had gotten only slightly out of sync with the overall project README. This commit updates its 'contributing' section to point at the appropriate contributing document.		2019-10-03 14:39:14 +04:00
..
.travis	Add 'pkg/arvo/' from commit 'c20e2a185f131ff3f5d3961829bd7a3fe0f227f8'	2019-06-28 12:48:05 +08:00
app	apps: added group/permission stores, hooks, marks	2019-09-30 14:46:07 -07:00
gen	hood: \|knob {tag} {level} to set dill verbosity	2019-09-29 20:45:10 +04:00
lib	hood: start up groups and permissions	2019-09-30 16:43:09 -07:00
mar	apps: added group/permission stores, hooks, marks	2019-09-30 14:46:07 -07:00
ren	updated publish files	2019-07-18 15:34:42 -07:00
sur	apps: added group/permission stores, hooks, marks	2019-09-30 14:46:07 -07:00
sys	arvo: clear caches in response to (high) memory pressure	2019-10-01 15:04:13 -07:00
tests	zuse: add en-xml:html and de-xml:html tests	2019-09-06 15:22:32 +10:00
.gitignore	Add 'pkg/arvo/' from commit 'c20e2a185f131ff3f5d3961829bd7a3fe0f227f8'	2019-06-28 12:48:05 +08:00
.travis.yml	Add 'pkg/arvo/' from commit 'c20e2a185f131ff3f5d3961829bd7a3fe0f227f8'	2019-06-28 12:48:05 +08:00
LICENSE.txt	Add 'pkg/arvo/' from commit 'c20e2a185f131ff3f5d3961829bd7a3fe0f227f8'	2019-06-28 12:48:05 +08:00
README.md	meta: update contributing section in arvo readme [ci skip]	2019-10-03 14:39:14 +04:00
TESTING.udon	Moved testing documentation out of tests folder so as to pass tests~	2019-07-05 16:48:40 -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 in dojo. +test /some/path would only run all tests in /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: @jtobin (~nidsut-tomdun)
/sys/vane/ames: @belisarius222 (~rovnys-ricfer) & @joemfb (~master-morzod)
/sys/vane/behn: @belisarius222 (~rovnys-ricfer)
/sys/vane/clay: @philipcmonk (~wicdev-wisryt)
/sys/vane/dill: @bernardodelaplaz (~rigdyn-sondur)
/sys/vane/eyre: @eglaysher (~littel-ponnys)
/sys/vane/ford: @belisarius222 (~rovnys-ricfer) & @eglaysher (~littel-ponnys)
/sys/vane/gall: @jtobin (~nidsut-tomdun)
/sys/vane/jael: @fang- (~palfun-foslup) & @joemfb (~master-morzod)
/app/acme: @joemfb (~master-morzod)
/app/dns: @joemfb (~master-morzod)
/app/hall: @fang- (~palfun-foslup)
/app/talk: @fang- (~palfun-foslup)
/app/aqua: @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.