From c71eb10c752377e3cddebae05101a6a922f9e556 Mon Sep 17 00:00:00 2001 From: Spencer Flagg Date: Thu, 3 Mar 2022 11:55:36 +0100 Subject: [PATCH 1/3] Update environment-setup.rst - changed 'to' to 'on' (grammar) - removed 'platform' (doesn't sound natural in 2022 english) - added `cd embassy-os` because the user is still in root - i had to close and open the terminal window at this point because `cargo`, which i had installed in the previous step, was not yet in the PATH - might want to consider one-lining this block of commands? not sure if there's value in keeping them separate - something like `git clone https://github.com/Start9Labs/embassy-os.git | ./embassy-os/backend/install-sdk.sh` i think? - under the EmbassyOS section, can you clarify something? is the "running instance" that you refer to the embassy-sdk that we just installed, or is it the instance running on the Embassy device? --- .../developer-docs/getting-started/environment-setup.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/site/source/developer-docs/getting-started/environment-setup.rst b/site/source/developer-docs/getting-started/environment-setup.rst index e75b481..512f3c7 100644 --- a/site/source/developer-docs/getting-started/environment-setup.rst +++ b/site/source/developer-docs/getting-started/environment-setup.rst @@ -46,7 +46,7 @@ To verify the installation, open a new terminal window and run: Docker ------ -`Docker `_ must be installed to your computer platform. It is needed to build an image for your package, which will be used to create the running instance of your package on EmbassyOS. In essence, it declares the necessary environment and building stages for your package to run. +`Docker `_ must be installed on your computer. It is needed to build an image for your package, which will be used to create the running instance of your package on EmbassyOS. In essence, it declares the necessary environment and building stages for your package to run. We also recommend installing and using `Docker buildx `_, as this adds desirable new features to the Docker build experience. It is included by default with Docker Desktop for Windows and macOS. @@ -74,6 +74,7 @@ To install the SDK: .. code:: bash git clone https://github.com/Start9Labs/embassy-os.git + cd embassy-os cd backend ./install-sdk.sh From 1046eb1c12d893e95e2bef864b61c0d430589a09 Mon Sep 17 00:00:00 2001 From: Lucy C <12953208+elvece@users.noreply.github.com> Date: Thu, 3 Mar 2022 08:49:42 -0700 Subject: [PATCH 2/3] add one line command --- .../developer-docs/getting-started/environment-setup.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/site/source/developer-docs/getting-started/environment-setup.rst b/site/source/developer-docs/getting-started/environment-setup.rst index 512f3c7..7437238 100644 --- a/site/source/developer-docs/getting-started/environment-setup.rst +++ b/site/source/developer-docs/getting-started/environment-setup.rst @@ -73,8 +73,7 @@ To install the SDK: .. code:: bash - git clone https://github.com/Start9Labs/embassy-os.git - cd embassy-os + git clone --recursive https://github.com/Start9Labs/embassy-os.git && cd embassy-os/backend && ./install-sdk.sh cd backend ./install-sdk.sh From 1d799ec6ed724477cd8fcb2513235661b462c6df Mon Sep 17 00:00:00 2001 From: Spencer Flagg Date: Thu, 3 Mar 2022 20:46:03 +0100 Subject: [PATCH 3/3] Update environment-setup.rst --- .../source/developer-docs/getting-started/environment-setup.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/site/source/developer-docs/getting-started/environment-setup.rst b/site/source/developer-docs/getting-started/environment-setup.rst index 7437238..b018356 100644 --- a/site/source/developer-docs/getting-started/environment-setup.rst +++ b/site/source/developer-docs/getting-started/environment-setup.rst @@ -74,8 +74,6 @@ To install the SDK: .. code:: bash git clone --recursive https://github.com/Start9Labs/embassy-os.git && cd embassy-os/backend && ./install-sdk.sh - cd backend - ./install-sdk.sh To verify the installation, open a terminal window and run: