From 643b0f869d0e7c3231ff91c98df86e374cf3396b Mon Sep 17 00:00:00 2001
From: Baptiste Augrain <daiyam@zokugun.org>
Date: Wed, 30 Jun 2021 10:24:06 +0200
Subject: [PATCH] - add build doc - improve terminal doc

---
 DOCS.md       |  8 ++++++
 docs/build.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+)
 create mode 100644 docs/build.md

diff --git a/DOCS.md b/DOCS.md
index 208d2e0..9cc1fab 100644
--- a/DOCS.md
+++ b/DOCS.md
@@ -12,6 +12,7 @@
 - [How do I run VSCodium in portable mode?](#portable)
 - [How do I press and hold a key and have it repeat in VSCodium?](#press-and-hold)
 - [How do I open VSCodium from the terminal?](#terminal-support)
+  - [From Linux .tar.gz](#from-linux-targz)
 
 ## <a id="disable-telemetry"></a>Getting all the Telemetry Out
 
@@ -135,6 +136,7 @@ $ defaults write com.visualstudio.code.oss ApplePressAndHoldEnabled -bool false
 
 ## <a id="terminal-support"></a>How do I open VSCodium from the terminal?
 
+For MacOS and Windows:
 - Go to the command palette (View | Command Palette...)
 - Choose `Shell command: Install 'codium' command in PATH`.
 
@@ -148,3 +150,9 @@ This allows you to open files or directories in VSCodium directly from your term
 ```
 
 Feel free to alias this command to something easier to type in your shell profile (e.g. `alias code=codium`).
+
+On Linux, when installed with a package manager, `codium` has been installed in your `PATH`.
+
+### <a id="from-linux-targz"></a>From Linux .tar.gz
+
+When the archive `VSCodium-linux-<arch>-<version>.tar.gz` is extracted, the main entry point for VSCodium is `./bin/codium`.
diff --git a/docs/build.md b/docs/build.md
new file mode 100644
index 0000000..bb1be6e
--- /dev/null
+++ b/docs/build.md
@@ -0,0 +1,69 @@
+# Build
+
+## Table of Contents
+
+- [Dependencies](#dependencies)
+  - [Linux](#dependencies-linux)
+  - [MacOS](#dependencies-macos)
+  - [Windows](#dependencies-windows)
+- [Build Scripts](#build-scripts)
+- [Build in Docker](#build-docker)
+
+## <a id="dependencies"></a>Dependencies
+
+- node 12
+- yarn
+- jq
+
+### <a id="dependencies-linux"></a>Linux
+
+- libx11-dev
+- libxkbfile-dev
+- libsecret-1-dev
+- fakeroot
+- rpm
+
+### <a id="dependencies-macos"></a>MacOS
+
+### <a id="dependencies-windows"></a>Windows
+
+- powershell
+- git
+- sed
+
+## <a id="build-scripts"></a>Build Scripts
+
+Each platform has its build helper script in the directory `build`.
+
+- Linux: `./build/build_linux.sh`
+- MacOS: `./build/build_macos_.sh`
+- Windows: `powershell -ExecutionPolicy ByPass -File .\build\build_windows.ps1`
+
+## <a id="build-docker"></a>Build in Docker
+
+To build for Linux, you can alternatively build VSCodium in docker
+
+Firstly, create the container with:
+```
+docker run -ti --volume=<local vscodium source>:/root/vscodium --name=vscodium-build-agent vscodium/vscodium-linux-build-agent:bionic-x64 bash
+```
+
+When inside the container, you can use the following commands to build:
+```
+curl -fsSL https://deb.nodesource.com/setup_12.x | sudo -E bash -
+sudo apt-get install -y nodejs
+
+npm install -g yarn
+
+git clone https://github.com/VSCodium/vscodium.git
+
+cd vscodium
+
+./get_repo.sh
+
+export SHOULD_BUILD=yes
+export OS_NAME=linux
+export VSCODE_ARCH=x64
+
+./build.sh
+```
\ No newline at end of file