tec3/ublue-forge
tec3/ublue-forge
1
0
Fork 0
mirror of https://github.com/ublue-os/forge.git synced 2025-07-06 01:35:45 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add and enhance documentation for gui, setup and usage (#34)

Browse source
This commit is contained in:
Stephan Lüscher 2024-05-10 22:04:43 +02:00 • committed by GitHub
parent 4f2130bcce
commit 4df5d1667e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 225 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/just.md Normal file
View file

@ -0,0 +1,31 @@
# Usage with just command runner
If you don't want to use the [GUI](./gui.md) we provide the following recipes
via [just command runner](https://github.com/casey/just).
<!-- markdownlint-disable MD013 -->
| Just recipe | Input argument | Description |
| --------------------- | ----------------------- | -------------------------------------------- |
| `forge_project-clone` | `forge_config_var_file` | Clone git project repository |
| `forge_project-build` | `forge_config_var_file` | Build container image and upload to registry |
<!-- markdownlint-enable MD013 -->
The input argument expects a [configuration](./index.md#configuration) file from the data store.
To launch a recipe you simple run:
```sh
just -f forge.just {{ recipe_name }} {{ forge_config_var_file }}
```
**_Example:_**
```sh
just -f forge.just forge_project-clone ~/ublue-os_forge/my-forge-project.env
```
In case you don't have [just command runner](https://github.com/casey/just) available.
Have a look at the [forge.just](../forge.just) file. It easy enough to understand which commands
are executed via the just recipes.