From 0f08dc56d2c08548c9a0c7a1f6788370fea8c073 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Sun, 6 Nov 2022 15:15:25 -0700 Subject: [PATCH 1/2] Minor fixes to flashing guide --- site/source/user-manual/flashing.rst | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/site/source/user-manual/flashing.rst b/site/source/user-manual/flashing.rst index 05f10dd..7379d3f 100644 --- a/site/source/user-manual/flashing.rst +++ b/site/source/user-manual/flashing.rst @@ -16,41 +16,37 @@ Extracting the image Linux ===== #. Download the ``eos.tar.gz`` file and open a terminal in the directory you save it to -#. (Optional, but recommended) Verify the checksum against the one listed on GitHub: - - .. code-block:: - - sha256sum eos.img.gz - #. Extract with: .. code-block:: - tar -xzvf eos.img.gz + tar -xzvf eos.tar.gz + +#. (Optional, but recommended) Verify the checksum against the one listed on GitHub: + + .. code-block:: + + sha256sum eos.img Mac === #. Download the ``eos.tar.gz`` file +#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract #. (Optional, but recommended) Verify the checksum against the one listed on GitHub: .. code-block:: - openssl dgst -sha256 eos.img.gz - -#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract + openssl dgst -sha256 eos.img Windows ======= #. Download the ``eos.zip`` file +#. Right-click eos.zip and click "Extract all" #. (Optional, but recommended) Verify the checksum against the one listed on GitHub: .. code-block:: - Get-FileHash eos.zip - -#. Right-click eos.zip and click "Extract all" - -In all cases you will be left with the file ``eos.img`` + Get-FileHash eos.img Installing embassyOS -------------------- From b670d4653280f4413892ad30edb76c0ddbd952d9 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Sun, 6 Nov 2022 15:52:46 -0700 Subject: [PATCH 2/2] Minor update to one-pager dev doc for x86 --- site/source/developer-docs/packaging.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/source/developer-docs/packaging.rst b/site/source/developer-docs/packaging.rst index fb990c1..081c5c4 100644 --- a/site/source/developer-docs/packaging.rst +++ b/site/source/developer-docs/packaging.rst @@ -40,7 +40,7 @@ Almost any type of open source software can be run on embassyOS. No matter what - The interfaces supported are: HTTP, TCP, and REST APIs -#. It can be compiled for ARM (``arm64v8``) +#. It can be compiled for ARM (``arm64v8`` - namely, the Raspberry Pi) and/or x86_64 (``amd64`` - most desktops, laptops, and servers) #. It can be served over TOR #. It creates a container image that is optimized for size (under 1GB) to save device space and expedite installation time @@ -199,7 +199,7 @@ After coding the build steps, build the Docker image using ``docker buildx``, re docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 -o type=docker,dest=image.tar . -The resulting ``image.tar`` artifact is the Docker image that needs to be included in the ``s9pk`` package. +The resulting ``docker-images/aarch64.tar`` or ``docker-images/x86_64.tar`` artifact (depending on if you used ``--platform=linux/arm64`` or ``--platform=linux/amd64`` is the Docker image that needs to be included in the ``s9pk`` package. .. _create-file-structure: