vegvisir/install
1
0
Fork 0
mirror of https://codeberg.org/vegvisir/install.git synced 2025-09-14 16:53:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc(style): use h3 heading size for argument references in README (#8)

Browse source 
Reviewed-on: https://codeberg.org/vegvisir/install/pulls/8
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
This commit is contained in:
Victor Westerlund 2025-08-07 10:39:20 +02:00 • committed by Victor Westerlund
parent 8859a741d3
commit 3e425c900e
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -15,25 +15,25 @@ curl -fsSL https://codeberg.org/vegvisir/install/raw/branch/master/install.sh |
# Arguments
You can pass optional named arguments to this script for headless installation of Vegvisir.
## `--install` - Don't install, only configure Vegvisir
### `--install` - Don't install, only configure Vegvisir
```sh
./install.sh --install=n
```
Pass `--install=n` to prevent download and installation of the Vegvisir git submodule. Use this option if you're version controlling Vegvisir from your project repository.
## `--dir` - Installation directory
### `--dir` - Installation directory
```sh
./install.sh --dir="/path/to/project"
```
Pass a `--dir` argument with a value of a directory Vegvisir should consider its [`root_path`](https://vegvisir.vlw.se/docs/Reference/Env#root_path).
## `--overwrite` - Overwrite configuration files
### `--overwrite` - Overwrite configuration files
```sh
./install.sh --overwrite=y
```
Pass `--overwrite=y` to replace existing Vegvisir configuration files.
## `--example` - Generate example website
### `--example` - Generate example website
```sh
./install.sh --example=n
```