Skip to content

Commit

Permalink
Add linux setup instructions (#535)
Browse files Browse the repository at this point in the history
  • Loading branch information
curtisman authored Jan 8, 2025
1 parent 6263c8a commit 21a7784
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
36 changes: 36 additions & 0 deletions docs/setup/setup-Linux.md
Original file line number Diff line number Diff line change
@@ -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`
2 changes: 1 addition & 1 deletion docs/setup/setup-Windows.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 21a7784

Please sign in to comment.