From ec7daa70e7997cc7fb68da70f05d2781241611d6 Mon Sep 17 00:00:00 2001 From: Max Howell Date: Thu, 23 Jan 2025 11:31:45 -0500 Subject: [PATCH] README tweaks --- .gitbook.yaml | 13 ++--- README.md | 136 ++++++++++++++++++++++++++------------------------ 2 files changed, 75 insertions(+), 74 deletions(-) diff --git a/.gitbook.yaml b/.gitbook.yaml index f25a919e..17712562 100644 --- a/.gitbook.yaml +++ b/.gitbook.yaml @@ -6,10 +6,6 @@ redirects: getting-started: 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: installing-pkgx.md ci-cd: installing-pkgx.md @@ -20,7 +16,8 @@ redirects: run-anywhere/scripts: scripting.md pantry.md: pkging/pantry.md pantry-api: pkging/pantry-api.md - pkgx-install: https://github.com/pkgxdev/pkgm - install: https://github.com/pkgxdev/pkgm - support: https://github.com/pkgxdev/discussions - dev: https://github.com/pkgxdev/dev + + pkgx-install: README.md + install: README.md + support: README.md + dev: README.md diff --git a/README.md b/README.md index 1277e3bd..0c3a868e 100644 --- a/README.md +++ b/README.md @@ -47,104 +47,105 @@ Python 2.7.18 ## Run Anywhere -*
macOS
+
macOS
- * macOS >= 11 - * 64 bit Intel & Apple Silicon +* macOS >= 11 +* 64 bit Intel & Apple Silicon -
-*
Linux
+
+
Linux
- * glibc >=2.28 [repology](https://repology.org/project/glibc/versions) - * `x86_64` & `arm64` +* glibc >=2.28 [repology](https://repology.org/project/glibc/versions) +* `x86_64` & `arm64` -
-*
Windows
+
+
Windows
- WSL2; x86-64. *Native windows is planned.* +WSL2; x86-64. *Native windows is planned.* -
-*
Docker
+
+
Docker
- We provide an image with `pkgx` in it: +We provide an image with `pkgx` in it: - ```sh - $ pkgx docker run -it pkgxdev/pkgx +```sh +$ pkgx docker run -it pkgxdev/pkgx - (docker) $ pkgx node@16 - Welcome to Node.js v16.20.1. - Type ".help" for more information. - > - ``` +(docker) $ pkgx node@16 +Welcome to Node.js v16.20.1. +Type ".help" for more information. +> +``` - You can use this image to try out (pretty much) any version of any program: +You can use this image to try out (pretty much) any version of any program: - ```sh - $ docker run pkgxdev/pkgx node@21.1 --version - v21.1.0 - ``` +```sh +$ docker run pkgxdev/pkgx node@21.1 --version +v21.1.0 +``` - Or in a `Dockerfile`: +Or in a `Dockerfile`: - ```Dockerfile - FROM pkgxdev/pkgx - RUN pkgx deno@1.35 task start - ``` +```Dockerfile +FROM pkgxdev/pkgx +RUN pkgx deno@1.35 task start +``` - Or in any image: +Or in any image: - ```Dockerfile - FROM ubuntu - RUN curl https://pkgx.sh | sh - RUN pkgx python@3.10 -m http.server 8000 - ``` +```Dockerfile +FROM ubuntu +RUN curl https://pkgx.sh | sh +RUN pkgx python@3.10 -m http.server 8000 +``` -
-*
CI/CD
+
+
CI/CD
- ```yaml - - uses: pkgxdev/setup@v3 - - run: pkgx shellcheck - ``` +```yaml +- uses: pkgxdev/setup@v3 +- run: pkgx shellcheck +``` - Or in other CI/CD providers: +Or in other CI/CD providers: - ```sh - curl https://pkgx.sh | sh - pkgx shellcheck - ``` +```sh +curl https://pkgx.sh | sh +pkgx shellcheck +``` -
-*
Scripts
+
+
Scripts
- ```sh - #!/usr/bin/env -S pkgx +git python@3.12 +```sh +#!/usr/bin/env -S pkgx +git python@3.12 - # python 3.12 runs the script and `git` is available during its execution - ``` +# python 3.12 runs the script and `git` is available during its execution +``` - > [docs.pkgx.sh/scripts] +> [docs.pkgx.sh/scripts] -
-*
Editors
+
+
Editors
- Use [`dev`][dev]; a separate tool that uses the pkgx primitives to - automatically determine and utilize your dependencies based on your - project’s keyfiles. +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 +```sh +$ cd myproj - myproj $ dev - +cargo +rust +myproj $ dev ++cargo +rust - myproj $ code . - ``` +myproj $ code . +``` -
+
  + # The `pkgx` Ecosystem `pkgx` is not just a package runner, it’s a composable primitive that can be @@ -341,6 +342,9 @@ cargo clippy --all-features pkgx npx markdownlint --config .github/markdownlint.yml --fix . ``` +  + + # Chat / Support / Questions We love a good chinwag.