docs: improve formatting and instructions

qe-collaborative-services · Jan 17, 2024 · 5edc9c9 · 5edc9c9
1 parent e0e95c3
commit 5edc9c9
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -33,12 +33,13 @@ analyst-friendly format, QCS-OE employs the following architecture strategy:
 
 ### Quick start (Windows):
 
-If you have a relatively modern Windows 10/11 system with `winget` you can use
-"Windows Terminal (Administrator)" to install Git, Deno, DuckDB, SQLite and VS
-Code IDE:
+If you have a relatively modern Windows 10/11 system with `winget` and `scoop`
+you can use "Windows Terminal (Administrator)" to install Git, Deno, DuckDB,
+SQLite and VS Code IDE:
 
 ```psh
 $ winget install Git.Git deno SQLite.SQLite DuckDB.cli Microsoft.VisualStudioCode
+$ scoop install sqlpage
 ```
 
 **IMPORTANT**: `winget` installations will update your PATH so exit your

diff --git a/support/docs/dependencies.md b/support/docs/dependencies.md
@@ -26,7 +26,7 @@ your platform.
 You can run `deno task doctor` (see below) to see if dependencies are installed
 properly.
 
-### Manage GitHub binaries with `eget`
+### Manage GitHub binaries with `eget` or `scoop` (Windows)
 
 A good way to get binaries from GitHub (e.g. SQLPage, et. al.) you should
 download and use [eget](https://github.com/zyedidia/eget/releases).
@@ -46,5 +46,11 @@ target = "D:\\bin"
 ["lovasoa/SQLpage"]
 ```
 
+On Windows you can also use [scoop](https://scoop.sh) to install binaries such as SQLPage:
+
+```psh
+$ scoop install sqlpage
+```
+
 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.
diff --git a/support/docs/linux-macos-setup.md b/support/docs/linux-macos-setup.md
@@ -3,7 +3,8 @@
 For Linux or MacOS use [pkgx](https://pkgx.sh/) and
 [eget](https://github.com/zyedidia/eget/releases) to install dependencies.
 
-Use `pkgx` by default, `eget` to get from GitHub directrly when `pkgx` is missing a package.
+Use `pkgx` by default, `eget` to get from GitHub directrly when `pkgx` is
+missing a package.
 
 ## Distro-specific packages to install (admin)
 

diff --git a/support/docs/windows-sandbox-setup.md b/support/docs/windows-sandbox-setup.md
@@ -1,6 +1,6 @@
 # Windows Sandbox Tips
 
-You can use *Windows Sandbox* for safe evaluation of this codebase.
+You can use _Windows Sandbox_ for safe evaluation of this codebase.
 
 ## Install Windows Store and `winget` in Sandbox First
 
@@ -25,12 +25,16 @@ Powershell (Admin)" session then proceed.
 
 ```psh
 winget install Microsoft.Powershell
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
 ```
 
 Exit the current "Windows Powershell (Admin)" session (close the window).
 
 Click on Windows icon, start "Microsoft Store", search for "Windows Terminal"
-and install it.
+and install it. This should work using
+`winget install Microsoft.WindowsTerminal` but as of 01-16-2024 the `winget`
+approach is not working so just use "Microsoft Store" installer.
 
 Launch Windows Terminal and proceed with "Quick start (Windows)" section in
 [README.md](../../README.md).