sigmasternchen/grimoire
1
0
Fork 0
mirror of https://github.com/sigmasternchen/grimoire synced 2025-03-15 08:08:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add pip-installation

Browse source
This commit is contained in:
sigmasternchen 2025-01-06 21:57:49 +01:00
parent 6df6c0b20b
commit 7fe6ce3d29
1 changed files with 20 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -14,9 +14,25 @@ for programming knowledge — simply modify YAML files to generate your site.
## Getting Started ## Getting Started
### Installation ### Installation & Usage
To get started with Grimoire, clone the repository and install the required dependencies: To get started with Grimoire, you can directly install it using pip:
```bash
pip install grimoire-ssg
```
To generate your static site, run the Grimoire command with your input YAML files.
You can specify an output directory using the `-o` or `--output` flag.
```bash
python -m grimoire-ssg -o output_directory one_or_more_input_files.yml
```
### Alternative Installation
Alternatively, you can clone the repository and install the
required dependencies with [Poetry](https://python-poetry.org/):
```bash ```bash
git clone https://github.com/sigmasternchen/grimoire-ssg.git git clone https://github.com/sigmasternchen/grimoire-ssg.git
@ -24,12 +40,10 @@ cd grimoire-ssg
poetry install poetry install
``` ```
### Usage You can then run the program directly using Poetry:
To generate your static site, run the Grimoire command with your input YAML files. You can specify an output directory using the `-o` or `--output` flag.
```bash ```bash
poetry run python -m grimoire-ssg -o output_directory input_file.yml poetry run python -m grimoire-ssg -o output_directory one_or_more_input_files.yml
``` ```
### Example YAML File ### Example YAML File