quirinecker/docki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added the readme once again

Browse Source
This commit is contained in:
quirinecker
2025-10-26 21:51:51 +01:00
parent 5b3ef929c4
commit a2f9622aaa
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -29,29 +29,29 @@ docki serve
## Installation ## Installation
### Nix
This installation method is recommended, because it will include both asciidoctor and asciidoctor_revealjs.
Note: This is the most basic installation. If you are already more experienced, you might want to add it to your shell or home manager configuration.
```shell
nix profile install github:quirinecker/docki
```
### Homebrew ### Homebrew
> [!NOTE] > [!NOTE]
> Installing it via homebrew will not include asciidoctor_revealjs. It can be installed afterwards with `docki install-reveal` > Installing it via homebrew will not include asciidoctor_revealjs. It can be installed afterwards with `docki install-reveal`
```shell ```shell
brew tap quirinecker/docki-homebrew https://github.com/quirinecker/docki-homebrew brew tap quirinecker/homebrew-docki https://github.com/quirinecker/homebrew-docki
``` ```
``` ```
brew install docki brew install docki
``` ```
### Nix
If you just want to try it out real quick and the nix package manager is available on your system you can use the following command.
```shell
nix develop github:quirinecker/docki#preview
```
This will open a shell evnironment with docki installed. If you want to install it permanently with nix, i would recommend following the instructions in the [Nix (Advanced, Flake)](#nix-(advanced%2C-flake)) section.
### Cargo ### Cargo
> [!NOTE] > [!NOTE]