Skip to content

Commit 57ee9ed

Browse files
committed
README tweaks
1 parent b03dea8 commit 57ee9ed

File tree

3 files changed

+82
-76
lines changed

3 files changed

+82
-76
lines changed

.gitbook.yaml

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ redirects:
66
getting-started: getting-started.md
77
quickstart: installing-pkgx.md
88

9-
help/pkg-not-cached: https://github.com/orgs/pkgxdev/discussions/new?category=help&title=pkg-not-cached
10-
help/http-failure: https://github.com/orgs/pkgxdev/discussions/new?category=help&title=http-failure
11-
help/ambiguous-pkgspec: https://github.com/orgs/pkgxdev/discussions/new?category=help&title=ambiguous-pkgspec
12-
139
# links should never die
1410
docker: installing-pkgx.md
1511
ci-cd: installing-pkgx.md
@@ -20,7 +16,8 @@ redirects:
2016
run-anywhere/scripts: scripting.md
2117
pantry.md: pkging/pantry.md
2218
pantry-api: pkging/pantry-api.md
23-
pkgx-install: https://github.com/pkgxdev/pkgm
24-
install: https://github.com/pkgxdev/pkgm
25-
support: https://github.com/pkgxdev/discussions
26-
dev: https://github.com/pkgxdev/dev
19+
20+
pkgx-install: README.md#pkgm
21+
install: README.md#pkgm
22+
support: README.md#support
23+
dev: README.md#dev

README.md

Lines changed: 70 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -47,104 +47,105 @@ Python 2.7.18
4747

4848
## Run Anywhere
4949

50-
* <details><summary>macOS</summary><br>
50+
<details><summary>macOS</summary><br>
5151

52-
* macOS >= 11
53-
* 64 bit Intel & Apple Silicon
52+
* macOS >= 11
53+
* 64 bit Intel & Apple Silicon
5454

55-
</details>
56-
* <details><summary>Linux</summary><br>
55+
</details>
56+
<details><summary>Linux</summary><br>
5757

58-
* glibc >=2.28 [repology](https://repology.org/project/glibc/versions)
59-
* `x86_64` & `arm64`
58+
* glibc >=2.28 [repology](https://repology.org/project/glibc/versions)
59+
* `x86_64` & `arm64`
6060

61-
</details>
62-
* <details><summary>Windows</summary><br>
61+
</details>
62+
<details><summary>Windows</summary><br>
6363

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

66-
</details>
67-
* <details><summary>Docker</summary><br>
66+
</details>
67+
<details><summary>Docker</summary><br>
6868

69-
We provide an image with `pkgx` in it:
69+
We provide an image with `pkgx` in it:
7070

71-
```sh
72-
$ pkgx docker run -it pkgxdev/pkgx
71+
```sh
72+
$ pkgx docker run -it pkgxdev/pkgx
7373

74-
(docker) $ pkgx node@16
75-
Welcome to Node.js v16.20.1.
76-
Type ".help" for more information.
77-
>
78-
```
74+
(docker) $ pkgx node@16
75+
Welcome to Node.js v16.20.1.
76+
Type ".help" for more information.
77+
>
78+
```
7979

80-
You can use this image to try out (pretty much) any version of any program:
80+
You can use this image to try out (pretty much) any version of any program:
8181

82-
```sh
83-
$ docker run pkgxdev/pkgx node@21.1 --version
84-
v21.1.0
85-
```
82+
```sh
83+
$ docker run pkgxdev/pkgx node@21.1 --version
84+
v21.1.0
85+
```
8686

87-
Or in a `Dockerfile`:
87+
Or in a `Dockerfile`:
8888

89-
```Dockerfile
90-
FROM pkgxdev/pkgx
91-
RUN pkgx deno@1.35 task start
92-
```
89+
```Dockerfile
90+
FROM pkgxdev/pkgx
91+
RUN pkgx deno@1.35 task start
92+
```
9393

94-
Or in any image:
94+
Or in any image:
9595

96-
```Dockerfile
97-
FROM ubuntu
98-
RUN curl https://pkgx.sh | sh
99-
RUN pkgx python@3.10 -m http.server 8000
100-
```
96+
```Dockerfile
97+
FROM ubuntu
98+
RUN curl https://pkgx.sh | sh
99+
RUN pkgx python@3.10 -m http.server 8000
100+
```
101101

102-
</details>
103-
* <details><summary>CI/CD</summary><br>
102+
</details>
103+
<details><summary>CI/CD</summary><br>
104104

105-
```yaml
106-
- uses: pkgxdev/setup@v3
107-
- run: pkgx shellcheck
108-
```
105+
```yaml
106+
- uses: pkgxdev/setup@v3
107+
- run: pkgx shellcheck
108+
```
109109
110-
Or in other CI/CD providers:
110+
Or in other CI/CD providers:
111111
112-
```sh
113-
curl https://pkgx.sh | sh
114-
pkgx shellcheck
115-
```
112+
```sh
113+
curl https://pkgx.sh | sh
114+
pkgx shellcheck
115+
```
116116

117-
</details>
118-
* <details><summary>Scripts</summary><br>
117+
</details>
118+
<details><summary>Scripts</summary><br>
119119

120-
```sh
121-
#!/usr/bin/env -S pkgx +git python@3.12
120+
```sh
121+
#!/usr/bin/env -S pkgx +git python@3.12
122122

123-
# python 3.12 runs the script and `git` is available during its execution
124-
```
123+
# python 3.12 runs the script and `git` is available during its execution
124+
```
125125

126-
> [docs.pkgx.sh/scripts]
126+
> [docs.pkgx.sh/scripts]
127127
128-
</details>
129-
* <details><summary>Editors</summary><br>
128+
</details>
129+
<details><summary>Editors</summary><br>
130130

131-
Use [`dev`][dev]; a separate tool that uses the pkgx primitives to
132-
automatically determine and utilize your dependencies based on your
133-
project’s keyfiles.
131+
Use [`dev`][dev]; a separate tool that uses the pkgx primitives to
132+
automatically determine and utilize your dependencies based on your
133+
project’s keyfiles.
134134

135-
```sh
136-
$ cd myproj
135+
```sh
136+
$ cd myproj
137137

138-
myproj $ dev
139-
+cargo +rust
138+
myproj $ dev
139+
+cargo +rust
140140

141-
myproj $ code .
142-
```
141+
myproj $ code .
142+
```
143143

144-
</details>
144+
</details>
145145

146146
&nbsp;
147147

148+
148149
# The `pkgx` Ecosystem
149150

150151
`pkgx` is not just a package runner, it’s a composable primitive that can be
@@ -341,6 +342,9 @@ cargo clippy --all-features
341342
pkgx npx markdownlint --config .github/markdownlint.yml --fix .
342343
```
343344
345+
&nbsp;
346+
347+
344348
# Chat / Support / Questions
345349
346350
We love a good chinwag.

docs/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ brew install pkgx || curl https://pkgx.sh | sh
1414

1515
## Using `pkgx`
1616

17-
| <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> |
18-
| ----- | ----- |
17+
* [Run Anything](running-anything.md)
18+
* [Scripting](scripting.md)
1919

2020
# The `pkgx` Ecosystem
2121

@@ -47,3 +47,8 @@ open source ecosystem available to them.
4747
{% hint style='info' %}
4848
[https://github.com/pkgxdev/mash](https://github.com/pkgxdev/mash)
4949
{% endhint %}
50+
51+
52+
# Support
53+
54+
[Discord](https://discord.gg/rNwNUY83XS)

0 commit comments

Comments
 (0)