Skip to content

Commit 46e1db2

Browse files
committed
docs: Updated documentation - features and contributing
1 parent 3ea7827 commit 46e1db2

4 files changed

Lines changed: 21 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ Check the [Documentation](https://f1bonacc1.github.io/process-compose/launcher/)
4949
- Run Multiple Replicas of a Process
5050
- Run a Foreground Process
5151
- Themes Support
52+
- On the fly Process configuration edit
53+
- On the fly Project update
54+
- [Recipes](https://github.com/F1bonacc1/process-compose-recipes) Management
5255

5356
It is heavily inspired by [docker-compose](https://github.com/docker/compose), but without the need for containers. The configuration syntax tries to follow the docker-compose specifications, with a few minor additions and lots of subtractions.
5457

@@ -72,6 +75,8 @@ It is heavily inspired by [docker-compose](https://github.com/docker/compose), b
7275
4. Push to the branch (git push origin my-new-feature)
7376
5. Create new Pull Request
7477

78+
See the [Contributing](https://f1bonacc1.github.io/process-compose/contributing/) page for more details.
79+
7580
English is not my native language, so PRs correcting grammar or spelling are welcome and appreciated.
7681

7782
### Consider supporting the project ❤️

imgs/tui.png

206 KB
Loading

www/docs/contributing.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,42 @@ Process Compose is written in Go.
44
### Prerequisites:
55

66
- [Make](https://www.gnu.org/software/make/)
7-
- [Go 1.22+](https://go.dev/doc/install)
7+
- [Go 1.24+](https://go.dev/doc/install)
8+
- [Nix](https://nix.dev/install-nix.html) - Optional, but recommended
89

910
### Clone Process Compose:
1011

11-
```
12+
```shell
1213
git clone git@github.com:F1bonacc1/process-compose.git
1314
```
1415

1516
`cd` into the directory and install the dependencies:
1617

17-
```
18+
```shell
1819
go mod tidy
1920
```
2021

2122
You should then be able to build the binary:
2223

23-
```
24+
```shell
2425
make build
2526
```
2627

28+
In case new packages were added (or updated), new nix vendor hash needs to be recalculated:
29+
30+
```shell
31+
make nix-update-hash
32+
```
33+
34+
:bulb: This step requires Nix to be installed.
35+
2736
## Test your change
2837

2938
You can create a branch for your changes and try to build from the source as you go.
3039

3140
When you are satisfied with the changes, we suggest you run:
3241

33-
```
42+
```shell
3443
make ci
3544
```
3645

www/docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Check the [Documentation](launcher.md) for more advanced use cases.
3030
- Process recovery policies
3131
- Manual process [re]start
3232
- Processes arguments `bash` or `zsh` style (or define your own shell)
33-
- Per process and global environment variables
33+
- Per process and global environment variables using [envsubst](https://github.com/drone/envsubst)
3434
- Per process or global (single file) logs
3535
- Health checks (liveness and readiness)
3636
- Terminal User Interface (TUI) or CLI modes
@@ -46,3 +46,4 @@ Check the [Documentation](launcher.md) for more advanced use cases.
4646
- Themes Support
4747
- On the fly Process configuration edit
4848
- On the fly Project update
49+
- [Recipes](https://github.com/F1bonacc1/process-compose-recipes) Management

0 commit comments

Comments
 (0)