README tweaks

Author: mxcl

.gitbook.yaml

@@ -1,22 +1,22 @@
 root:
   ./docs/
 redirects:
-  installing-w/out-brew: getting-started.md
+  installing-w/out-brew: installing-pkgx.md
   pantry: pkging/pantry.md
   getting-started: getting-started.md
-  quickstart: getting-started.md
+  quickstart: installing-pkgx.md
 
   help/pkg-not-cached: https://github.com/orgs/pkgxdev/discussions/new?category=help&title=pkg-not-cached
   help/http-failure: https://github.com/orgs/pkgxdev/discussions/new?category=help&title=http-failure
   help/ambiguous-pkgspec: https://github.com/orgs/pkgxdev/discussions/new?category=help&title=ambiguous-pkgspec
 
   # links should never die
-  docker: getting-started.md
-  ci-cd: getting-started.md
+  docker: installing-pkgx.md
+  ci-cd: installing-pkgx.md
   scripts: scripting.md
-  run-anywhere/terminals: getting-started.md
-  run-anywhere/docker: getting-started.md
-  run-anywhere/ci-cd: getting-started.md
+  run-anywhere/terminals: installing-pkgx.md
+  run-anywhere/docker: installing-pkgx.md
+  run-anywhere/ci-cd: installing-pkgx.md
   run-anywhere/scripts: scripting.md
   pantry.md: pkging/pantry.md
   pantry-api: pkging/pantry-api.md

README.md

@@ -1,6 +1,6 @@
 ![pkgx.dev](https://pkgx.dev/banner.png)
 
-`pkgx` is a 4MB, *standalone* binary that can *run anything*.
+`pkgx` is a 4 MiB, standalone binary that can *run anything*.
 
 [![coverage][]][coveralls] [![teaRank][]](https://tea.xyz)
 
@@ -50,7 +50,7 @@ Python 2.7.18
 * <details><summary>macOS</summary><br>
 
   * macOS >= 11
-  * x86-64 & Apple Silicon
+  * 64 bit Intel & Apple Silicon
 
   </details>
 * <details><summary>Linux</summary><br>
@@ -66,6 +66,8 @@ Python 2.7.18
   </details>
 * <details><summary>Docker</summary><br>
 
+  We provide an image with `pkgx` in it:
+
   ```sh
   $ pkgx docker run -it pkgxdev/pkgx
 
@@ -75,6 +77,13 @@ Python 2.7.18
   >
   ```
 
+  You can use this image to try out (pretty much) any version of any program:
+
+  ```sh
+  $ docker run pkgxdev/pkgx pkgx node@21.1 --version
+  v21.1.0
+  ```
+
   Or in a `Dockerfile`:
 
   ```Dockerfile
@@ -90,13 +99,11 @@ Python 2.7.18
   RUN pkgx python@3.10 -m http.server 8000
   ```
 
-  > [docs.pkgx.sh/docker]
-
   </details>
 * <details><summary>CI/CD</summary><br>
 
   ```yaml
-  - uses: pkgxdev/setup@v2
+  - uses: pkgxdev/setup@v3
   - run: pkgx shellcheck
   ```
 
@@ -107,8 +114,6 @@ Python 2.7.18
   pkgx shellcheck
   ```
 
-  > [docs.pkgx.sh/ci-cd]
-
   </details>
 * <details><summary>Scripts</summary><br>
 
@@ -123,28 +128,19 @@ Python 2.7.18
   </details>
 * <details><summary>Editors</summary><br>
 
-  ```sh
-  $ cd myproj
-
-  myproj $ env +cargo
-  (+cargo) myproj $ code .
-  ```
-
-  Or use [`dev`][dev]; a separate tool that uses the pkgx primitives to
+  Use [`dev`][dev]; a separate tool that uses the pkgx primitives to
   automatically determine and utilize your dependencies based on your
   project’s keyfiles.
 
   ```sh
   $ cd myproj
 
   myproj $ dev
-  env +cargo +rust
+  +cargo +rust
 
-  (+cargo+rust) my-rust-project $ code .
+  myproj $ code .
   ```
 
-  > [docs.pkgx.sh/editors]
-
   </details>
 
 &nbsp;

docs/README.md

@@ -1,14 +1,16 @@
 # `pkgx`
 
-`pkgx` is a 4MB, *standalone binary* that can *run anything*.
+`pkgx` is a 4 MiB, standalone binary that can *run anything*.
 
 ## Quick Start
 
 ```sh
 brew install pkgx || curl https://pkgx.sh | sh
 ```
 
-[Getting Started Guide](getting-started.md)
+{% hint style='info' %}
+[Installation Guide](installing-pkgx.md)
+{% endhint %}
 
 ## Using `pkgx`
 
@@ -25,17 +27,23 @@ used to build a whole ecosystem of tools. Here’s what we’ve built so far:
 `dev` uses shellcode and `pkgx` to create “virtual environments” for any
 project and any toolset.
 
-> [https://github.com/pkgxdev/dev](https://github.com/pkgxdev/dev)
+{% hint style='info' %}
+[https://github.com/pkgxdev/dev](https://github.com/pkgxdev/dev)
+{% endhint %}
 
 ## `pkgm`
 
 `pkgm` installs `pkgx` packages to `/usr/local`.
 
-> [https://github.com/pkgxdev/pkgm](https://github.com/pkgxdev/pkgm)
+{% hint style='info' %}
+[https://github.com/pkgxdev/pkgm](https://github.com/pkgxdev/pkgm)
+{% endhint %}
 
 ## `mash`
 
 `mash` is a package manager for scripts that use `pkgx` to make the whole
 open source ecosystem available to them.
 
-> [https://github.com/pkgxdev/mash](https://github.com/pkgxdev/mash)
+{% hint style='info' %}
+[https://github.com/pkgxdev/mash](https://github.com/pkgxdev/mash)
+{% endhint %}

docs/SUMMARY.md

@@ -1,10 +1,10 @@
 ‌# Summary​
 
 * [Highlights](README.md)
-* [Installing `pkgx`](getting-started.md)
 
 ## `pkgx`
 
+* [Installing `pkgx`](installing-pkgx.md)
 * [Getting Started](pkgx.md)
 * [Scripting](scripting.md)
 
@@ -14,7 +14,6 @@
 * [`pkgm`](https://github.com/pkgxdev/pkgm)
 * [`mash`](https://github.com/pkgxdev/mash)
 ​
-
 ## Appendix
 
 * [FAQ](faq.md)

docs/deeper-dives/conceptual-overview.md

@@ -1,6 +1,4 @@
-# Appendix
-
-## How `pkgx` Works: A Conceptual Overview
+# How `pkgx` Works: A Conceptual Overview
 
 Everything `pkgx` does involves initially creating package environment. It then
 either runs commands inside those environments or injects those environments