Skip to content

Commit 910ba15

Browse files
chadmedConan-Kudo
authored andcommitted
README: shorten line lengths
Makes it a lot nicer to work with in a text editor Signed-off-by: James Calligeros <[email protected]>
1 parent 92c4bdf commit 910ba15

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Asahi Linux documentation repository
2-
32
This is the [Asahi Linux documentation](https://asahilinux.org/docs/) repository.
43

54
## Documentation structure
@@ -21,7 +20,10 @@ Our documentation is organised into categories.
2120

2221
## Usage
2322

24-
This is made with [MkDocs](https://www.mkdocs.org/). If you have mkdocs installed already, run `make build` to build the site, or `make test` to spin up a local webserver for review. If you don't, feel free to use our [container](https://github.com/AsahiLinux/docs/pkgs/container/mkdocs-asahi) with something like:
23+
This is made with [MkDocs](https://www.mkdocs.org/). If you have mkdocs installed
24+
already, run `make build` to build the site, or `make test` to spin up a local webserver
25+
for review. If you don't, feel free to use our [container](https://github.com/AsahiLinux/docs/pkgs/container/mkdocs-asahi)
26+
with something like:
2527

2628
```
2729
$ podman run -it --pull=newer -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
@@ -33,6 +35,9 @@ if you're using [Podman](https://podman.io), or
3335
$ docker run -it --pull=always -p=8000:8000 -v=$(pwd)/:/docs:z ghcr.io/asahilinux/mkdocs-asahi:latest
3436
```
3537

36-
if you're using [Docker](https://www.docker.com). Note that this repository uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so you'll want to set those up first with `git submodule update --init`.
38+
if you're using [Docker](https://www.docker.com). Note that this repository uses
39+
[Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so you'll
40+
want to set those up first with `git submodule update --init`.
3741

38-
The website is rebuilt by the CI on every commit and served via GitHub Pages. The container is also automatically updated and pushed to the registry.
42+
The website is rebuilt by the CI on every commit and served via GitHub Pages.
43+
The container is also automatically updated and pushed to the registry.

0 commit comments

Comments
 (0)