From 7791b8765c382d4d2933cb1b0facd28193e144bc Mon Sep 17 00:00:00 2001 From: Curtis Man Date: Wed, 8 Jan 2025 13:58:26 -0800 Subject: [PATCH] Add debian as a tested linux setup. (#536) --- README.md | 2 +- docs/setup/setup-Linux.md | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 80d02b5f5..a78d788d0 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 (Ubuntu)](./docs/setup/setup-Linux.md) +- [Linux (Ubuntu/Debian)](./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 index adacce757..4b16513c4 100644 --- a/docs/setup/setup-Linux.md +++ b/docs/setup/setup-Linux.md @@ -2,7 +2,7 @@ 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 +Instructions tested with Ubuntu 24.04.1 LTS and Debian 12.8.0 ## Build @@ -26,11 +26,12 @@ Instruction tested with Ubuntu 24.04.1 LTS ## 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` +- Run the TypeAgent shell: + - (Ubuntu 24.04) `pnpm run shell --noSandbox` (see [issue](https://github.com/electron/electron/issues/18265)) + - Other: `pnpm run shell` ## Development - Install VSCode ([download](https://code.visualstudio.com/download)) -- Start VSCode in WSL (_Continued from above command prompt in WSL_) +- Start VSCode - `code ~/src/TypeAgent/ts`