mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 02:11:53 +00:00
Build README update (#738)
* Build README update * Formatting edit * Formatting edit * Formatting edit * #️⃣ Make it simple (#743) Co-authored-by: Mariusz Kogen <k0gen@pm.me>
This commit is contained in:
committed by
Aiden McClelland
parent
f5841b95d9
commit
787993971b
@@ -1,34 +1,40 @@
|
|||||||
# Building Embassy OS
|
# Building Embassy OS
|
||||||
|
|
||||||
|
The commands given assume a Debian or Ubuntu-based environment.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. Install dependences - The commands given assume a Debian or Ubuntu-based environment
|
1. Install dependences
|
||||||
|
|
||||||
- Rust
|
|
||||||
`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
|
|
||||||
https://rustup.rs
|
|
||||||
- Avahi
|
- Avahi
|
||||||
`apt install avahi`
|
- `sudo apt install -y avahi-daemon`
|
||||||
Installed by default on most Debian systems - https://avahi.org
|
- Installed by default on most Debian systems - https://avahi.org
|
||||||
- Docker
|
- Docker
|
||||||
`apt install docker.io`
|
- `sudo apt install -y docker.io`
|
||||||
https://docs.docker.com/get-docker
|
- https://docs.docker.com/get-docker
|
||||||
|
- Add your user to the docker group: `sudo usermod -a -G docker $USER`
|
||||||
|
- If you have issues here, try to logout or reboot your system
|
||||||
|
- Prepare Docker environment
|
||||||
|
- Setup buildx (https://docs.docker.com/buildx/working-with-buildx/)
|
||||||
|
- Create a builder: `docker buildx create --use`
|
||||||
|
- Add multi-arch build ability: `docker run --rm --privileged linuxkit/binfmt:v0.8`
|
||||||
- Node
|
- Node
|
||||||
`apt install nodejs`
|
- `sudo apt install -y nodejs`
|
||||||
https://nodejs.org/en/docs
|
- https://nodejs.org/en/docs
|
||||||
- NPM
|
- NPM
|
||||||
`apt install npm`
|
- `sudo apt install -y npm`
|
||||||
https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
|
- https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
|
||||||
- jq
|
- jq
|
||||||
`apt install jq`
|
- `sudo apt install -y jq`
|
||||||
https://stedolan.github.io/jq
|
- https://stedolan.github.io/jq
|
||||||
|
|
||||||
2. Clone the repo and move into it
|
2. Clone the repo, move into it, and bring in required submodules
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone --recursive https://github.com/Start9Labs/embassy-os.git`
|
git clone --recursive https://github.com/Start9Labs/embassy-os.git
|
||||||
cd embassy-os
|
cd embassy-os
|
||||||
```
|
git submodule update --init --recursive
|
||||||
|
```
|
||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
@@ -46,4 +52,4 @@ We recommend [Balena Etcher](https://www.balena.io/etcher/)
|
|||||||
|
|
||||||
Visit http://embassy.local from any web browser
|
Visit http://embassy.local from any web browser
|
||||||
|
|
||||||
We recommend [Firefox](https://www.mozilla.org/en-US/firefox/browsers
|
We recommend [Firefox](https://www.mozilla.org/firefox/browsers)
|
||||||
|
|||||||
Reference in New Issue
Block a user