Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-26 10:21:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up README (#1114)

Browse Source 
* Update README.md

* updated readme assets

* delete deprecated lifeline

* update contributing guide and delete old build guides/notes

* fix typos

* update ui formatting recommendation

* update readmes and contributing guide with build steps and dependencies

* add script to install sdk

Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
Matt Hill
2022-01-24 15:24:02 -07:00
committed by GitHub
parent 24656d4824
commit 8a559b71fd
24 changed files with 144 additions and 665 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -9,24 +9,21 @@
[![mastodon](https://img.shields.io/mastodon/follow/000000001?domain=https%3A%2F%2Fmastodon.start9labs.com&label=Follow&style=social)](http://mastodon.start9labs.com)
[![twitter](https://img.shields.io/twitter/follow/start9labs?label=Follow)](https://twitter.com/start9labs)
### _A personal server for everyone._ ###
### _Welcome to the era of Sovereign Computing_ ###
EmbassyOS is an open-source operating system designed to empower anyone at any technical skill level to self-host.
EmbassyOS is a browser-based, graphical operating system for a personal server. EmbassyOS facilitates the discovery, installation, network configuration, service configuration, data backup, dependency management, and health monitoring of self-hosted software services. It is the most advanced, secure, reliable, and user friendly personal server OS in the world.
## Running EmbassyOS
There are multiple ways to obtain and begin using EmbassyOS.
## :heart: Contributing
To contribute to the development of EmbassyOS, see [here](https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md).
There are multiple ways to get your hands on EmbassyOS.
### :moneybag: Buy an Embassy
This is the most convenient option. Simply [buy an Embassy](https://start9.com) from Start9 Labs and plug it in. Depending on where you live, shipping costs and import duties may vary.
This is the most convenient option. Simply [buy an Embassy](https://start9.com) from Start9 and plug it in. Depending on where you live, shipping costs and import duties will vary.
### :construction_worker: 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 prefer not to divulge your physical address.
1. You just like building things.
To pursue this option, follow this [guide](https://docs.start9.com/getting-started/diy.html).
@@ -36,5 +33,14 @@ To pursue this option, follow this [guide](https://docs.start9.com/getting-start
EmbassyOS can be built from source, for personal use, for free.
A detailed guide for doing so can be found [here](https://github.com/Start9Labs/embassy-os/blob/master/build/README.md).
## :heart: Contributing
There are multiple ways to contribute: work directly on EmbassyOS, package a service for the marketplace, or help with documentation and guides. To learn more about contributing, see [here](https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md).
## UI Screenshots
<img src="assets/EmbassyOS.png" alt="Embassy Services" width="100%">
<img src="assets/EmbassyOS.png" alt="EmbassyOS" width="60%">
<br>
<img src="assets/eos-services.png" alt="Embassy Services" width="60%"> |
<img src="assets/eos-preferences.png" alt="Embassy Preferences" width="60%">
--- | ---
<img src="assets/eos-bitcoind-health-check.png" alt="Embassy Bitcoin Health Checks" width="60%"> |
<img src="assets/eos-logs.png" alt="Embassy Logs" width="60%">