repo: update documentation

This commit is contained in:
Aiden McClelland
2020-12-22 17:49:57 -07:00
parent 83dbc0f0cc
commit 69cfe3daf4
2 changed files with 86 additions and 18 deletions

View File

@@ -1,3 +1,24 @@
# Embassy OS
# EmbassyOS
### _Anyone can do it. No one can stop it._ ###
## Building from Source
EmbassyOS is a mass-market, graphical operating system designed to facilitate the discovery, installation, configuration, private self-hosting, and reliable operation of open-source software services and applications. It aims to eliminate trust and custodianship from personal computing.
![EmbassyOS image](https://sesoodan.sirv.com/0.2.5.png)
## Running EmbassyOS
There are multiple ways to obtain and begin using EmbassyOS.
### Buy an Embassy
This is the most convenient option. Simply [buy an Embassy](https://start9labs.com) from Start9 Labs and plug it in. Depending on where you live, shipping costs and import duties may vary.
### Build your own Embassy
While not as convenient as buying an Embassy, this option is easier than you might imagine, and there are 4 reasons why you might prefer it:
1. You already have a Raspberry Pi and would like to re-purpose it.
1. You want to save on shipping costs.
1. You prefer not to divulge your physical shipping address.
1. You just like building things.
To pursue this option, follow this [guide](https://docs.start9labs.com/getting-started/diy.html).
## Contributing
To build EmbassyOS from source, or to contribute to its development, see [here](https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md#building-the-image).