mirror of
https://github.com/urbit/shrub.git
synced 2024-12-24 03:14:30 +03:00
8920bf0dc5
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.
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
# Arvo
|
|
|
|
A clean-slate operating system.
|
|
|
|
## Usage
|
|
|
|
To run Arvo, you'll need [Urbit](https://github.com/urbit/urbit/). To install
|
|
Urbit and run Arvo please follow the instructions in the [getting started
|
|
docs](https://urbit.org/docs/getting-started/). 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](https://urbit.org/docs/learn/arvo/).
|
|
|
|
## 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][cont] for details on our git practices, coding
|
|
styles, how we manage issues, and so on.
|
|
|
|
You might also be interested in:
|
|
|
|
- joining the [urbit-dev][list] mailing list.
|
|
- [applying to Hoon School][mail], a course we run to teach the Hoon
|
|
programming language and Urbit application development.
|
|
|
|
[list]: https://groups.google.com/a/urbit.org/forum/#!forum/dev
|
|
[mail]: mailto:support@urbit.org
|
|
[cont]: https://github.com/urbit/urbit/blob/master/CONTRIBUTING.md
|