Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
mxcl committed Jan 23, 2025
1 parent b03dea8 commit 57ee9ed
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 76 deletions.
13 changes: 5 additions & 8 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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#pkgm
install: README.md#pkgm
support: README.md#support
dev: README.md#dev
136 changes: 70 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,104 +47,105 @@ Python 2.7.18

## Run Anywhere

* <details><summary>macOS</summary><br>
<details><summary>macOS</summary><br>

* macOS >= 11
* 64 bit Intel & Apple Silicon
* macOS >= 11
* 64 bit Intel & Apple Silicon

</details>
* <details><summary>Linux</summary><br>
</details>
<details><summary>Linux</summary><br>

* 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`

</details>
* <details><summary>Windows</summary><br>
</details>
<details><summary>Windows</summary><br>

WSL2; x86-64. *Native windows is planned.*
WSL2; x86-64. *Native windows is planned.*

</details>
* <details><summary>Docker</summary><br>
</details>
<details><summary>Docker</summary><br>

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 [email protected] --version
v21.1.0
```
```sh
$ docker run pkgxdev/pkgx [email protected] --version
v21.1.0
```

Or in a `Dockerfile`:
Or in a `Dockerfile`:

```Dockerfile
FROM pkgxdev/pkgx
RUN pkgx [email protected] task start
```
```Dockerfile
FROM pkgxdev/pkgx
RUN pkgx [email protected] task start
```

Or in any image:
Or in any image:

```Dockerfile
FROM ubuntu
RUN curl https://pkgx.sh | sh
RUN pkgx [email protected] -m http.server 8000
```
```Dockerfile
FROM ubuntu
RUN curl https://pkgx.sh | sh
RUN pkgx [email protected] -m http.server 8000
```

</details>
* <details><summary>CI/CD</summary><br>
</details>
<details><summary>CI/CD</summary><br>

```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
```

</details>
* <details><summary>Scripts</summary><br>
</details>
<details><summary>Scripts</summary><br>

```sh
#!/usr/bin/env -S pkgx +git [email protected]
```sh
#!/usr/bin/env -S pkgx +git [email protected]

# 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]
</details>
* <details><summary>Editors</summary><br>
</details>
<details><summary>Editors</summary><br>

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 .
```

</details>
</details>

&nbsp;


# The `pkgx` Ecosystem

`pkgx` is not just a package runner, it’s a composable primitive that can be
Expand Down Expand Up @@ -341,6 +342,9 @@ cargo clippy --all-features
pkgx npx markdownlint --config .github/markdownlint.yml --fix .
```
&nbsp;
# Chat / Support / Questions
We love a good chinwag.
Expand Down
9 changes: 7 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ brew install pkgx || curl https://pkgx.sh | sh

## Using `pkgx`

| <p>​<a href="running-anything.md">Run Anything</a><br>Run anything with `pkgx`</p> | <p><a href="scripting.md">Scripting</a><br>Write scripts in any language with all the tools you need available from L:1</p> |
| ----- | ----- |
* [Run Anything](running-anything.md)
* [Scripting](scripting.md)

# The `pkgx` Ecosystem

Expand Down Expand Up @@ -47,3 +47,8 @@ open source ecosystem available to them.
{% hint style='info' %}
[https://github.com/pkgxdev/mash](https://github.com/pkgxdev/mash)
{% endhint %}


# Support

[Discord](https://discord.gg/rNwNUY83XS)

0 comments on commit 57ee9ed

Please sign in to comment.