From 21a778468027f3bc755b25b013a358bf36da2088 Mon Sep 17 00:00:00 2001
From: Curtis Man <curtism@microsoft.com>
Date: Wed, 8 Jan 2025 11:55:44 -0800
Subject: [PATCH] Add linux setup instructions (#535)

---
 README.md                   |  2 +-
 docs/setup/setup-Linux.md   | 36 ++++++++++++++++++++++++++++++++++++
 docs/setup/setup-Windows.md |  2 +-
 3 files changed, 38 insertions(+), 2 deletions(-)
 create mode 100644 docs/setup/setup-Linux.md

diff --git a/README.md b/README.md
index 77994f4c0..80d02b5f5 100644
--- a/README.md
+++ b/README.md
@@ -69,7 +69,7 @@ Follow these quick starts for step-by-step instructions to quickly setup tools a
 
 - [Windows](./docs/setup/setup-Windows.md)
 - [WSL2](./docs/setup/setup-WSL2.md)
-- Linux (coming soon)
+- [Linux (Ubuntu)](./docs/setup/setup-Linux.md)
 - MacOS (coming soon)
 
 See the [instructions](./ts/README.md) in the TypeScript code [directory](./ts) for more detailed setup instructions.
diff --git a/docs/setup/setup-Linux.md b/docs/setup/setup-Linux.md
new file mode 100644
index 000000000..adacce757
--- /dev/null
+++ b/docs/setup/setup-Linux.md
@@ -0,0 +1,36 @@
+# Linux environment setup
+
+This is a list of step-by-step instructions to set up a Linux environment from _scratch_ to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. The instruction will install and setup the necessary tools and put the repo in `~/src/TypeAgent`. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Skip or change the steps as necessary to suit your needs.
+
+Instruction tested with Ubuntu 24.04.1 LTS
+
+## Build
+
+- Install git and curl
+  - `sudo apt update`
+  - `sudo apt install git curl`
+- Setup node
+  - Setup [NVM](https://github.com/nvm-sh/nvm)
+    - `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash`
+    - `source ~/.bashrc`
+  - Install Node
+    - `nvm install --lts`
+- Clone and build:
+  - `git clone https://github.com/microsoft/TypeAgent ~/src/TypeAgent`
+  - `cd ~/src/TypeAgent/ts`
+  - `corepack enable`
+  - `pnpm setup`
+  - `pnpm i`
+  - `pnpm run build`
+
+## Run
+
+- Setup Service Keys (See instructions [here](./../../ts/README.md#service-keys))
+- Run the TypeAgent shell (without sandbox for electron in Ubuntu 24.04, see [issue](https://github.com/electron/electron/issues/18265))
+  - `pnpm run shell --noSandbox`
+
+## Development
+
+- Install VSCode ([download](https://code.visualstudio.com/download))
+- Start VSCode in WSL (_Continued from above command prompt in WSL_)
+  - `code ~/src/TypeAgent/ts`
diff --git a/docs/setup/setup-Windows.md b/docs/setup/setup-Windows.md
index 1b91066ec..3e5334982 100644
--- a/docs/setup/setup-Windows.md
+++ b/docs/setup/setup-Windows.md
@@ -1,6 +1,6 @@
 # Windows environment setup
 
-This is a list of step-by-step instructions to set up a Windows environment from _scratch_ to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. The instruction will install and setup the necessary tools and put the repo in C:\src\TypeAgent. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Skip or change the steps as necessary to suit your needs.
+This is a list of step-by-step instructions to set up a Windows environment from _scratch_ to build, run, and develop the TypeAgent repo, collated from various READMEs throughout the repo and external source. The instruction will install and setup the necessary tools and put the repo in `C:\src\TypeAgent`. Links to the original instructions for each part are provided for reference, but mostly not required to visit if you just follow the instructions here. Skip or change the steps as necessary to suit your needs.
 
 ## Build