Skip to content

Commit

Permalink
docs: improve Windows instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shah committed Jan 16, 2024
1 parent 7310fa4 commit 7987720
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 35 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ session and VS Code _before you try out the code_.
If you want a nice, easier to read, CLI prompt install and setup
[Oh My Posh](https://ohmyposh.dev/docs/installation/windows).

You can also evaluate the code in a
[Windows Sandbox](./support/docs/windows-sandbox-setup.md) environment

### Quick start (Linux or MacOS):

For Linux or MacOS use [pkgx](https://pkgx.sh/) and
Expand All @@ -72,12 +75,13 @@ Once you've installed Git and Deno you can run the code directly from GitHub
(the latest version or any specific pinned version) without cloning the GitHub
repo or clone the repo and run the code locally.

The instructions below assume `D:\workspaces` as your workspaces root but you
The instructions below assume `c:\workspaces` as your workspaces root but you
should change that to `D:\` or `/home/user/workspaces` or whatever your
workspaces root happens to be (based on your operating system).

```bash
$ cd D:\workspaces # or wherever your sources are stored
$ md c:\workspaces # create the destination if required
$ cd c:\workspaces # or wherever your sources are stored
$ deno run -A https://raw.githubusercontent.com/qe-collaborative-services/workspaces/main/ws-bootstrap-typical.ts

# after repo cloning command (above) is complete:
Expand Down
33 changes: 0 additions & 33 deletions support/docs/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,36 +48,3 @@ target = "D:\\bin"

4. CD into `D:\bin` (or `C:\\Program Files\\qe-cs` or whatever you created in
step #1) and run `eget /D` to download all required binaries.

## Use Windows Sandbox for Safe Evaluation

### Install Windows Store and `winget` in Sandbox First

Right-click on Windows icon, start "Windows Powershell (Admin)" session and do
the following to install Microsoft Store in the Sandbox:

```psh
Set-ExecutionPolicy Bypass -Scope Process -Force
$url="https://github.com/bonben365/add-store-win-sandbox/raw/main/install.ps1"
iex ((New-Object System.Net.WebClient).DownloadString($url))
```

Now install the Windows Package Manager (`winget`) in Sandbox using
[these instructions](https://learn.microsoft.com/en-us/windows/package-manager/winget/#install-winget-on-windows-sandbox).

Exit the current "Windows Powershell (Admin)" session restart another "Windows
Powershell (Admin)" session then proceed.

### Install PowerShell 7+ and Windows Terminal

```psh
winget install Microsoft.Powershell
```

Exit the current "Windows Powershell (Admin)" session (close the window).

Click on Windows icon, start "Microsoft Store", search for "Windows Terminal"
and install it.

Launch Windows Terminal and proceed with "Quick start (Windows)" section in
[README.md](../../README.md).
36 changes: 36 additions & 0 deletions support/docs/windows-sandbox-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Windows Sandbox Tips

You can use *Windows Sandbox* for safe evaluation of this codebase.

## Install Windows Store and `winget` in Sandbox First

Right-click on Windows icon, start "Windows Powershell (Admin)" session and do
the following to install Microsoft Store in the Sandbox:

```psh
Set-ExecutionPolicy Bypass -Scope Process -Force
$url="https://github.com/bonben365/add-store-win-sandbox/raw/main/install.ps1"
iex ((New-Object System.Net.WebClient).DownloadString($url))
```

Exit the current "Windows Powershell (Admin)" session restart another "Windows
Powershell (Admin)" session then proceed to install the Windows Package Manager
(`winget`) in Sandbox using
[these instructions](https://learn.microsoft.com/en-us/windows/package-manager/winget/#install-winget-on-windows-sandbox).

Exit the current "Windows Powershell (Admin)" session restart another "Windows
Powershell (Admin)" session then proceed.

## Install PowerShell 7+ and Windows Terminal

```psh
winget install Microsoft.Powershell
```

Exit the current "Windows Powershell (Admin)" session (close the window).

Click on Windows icon, start "Microsoft Store", search for "Windows Terminal"
and install it.

Launch Windows Terminal and proceed with "Quick start (Windows)" section in
[README.md](../../README.md).

0 comments on commit 7987720

Please sign in to comment.