docs: update README
This commit is contained in:
@@ -1,9 +1,17 @@
|
|||||||
# Project Manager
|
# Project Manager
|
||||||
|
|
||||||
|
Automatically detects modules and executes commands
|
||||||
|
|
||||||
|
Supported types:
|
||||||
|
|
||||||
|
- python (poetry)
|
||||||
|
- nodejs (npm)
|
||||||
|
- docker
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pipx install project-manager -i https://git.shmyga.ru/InfernalGames/project-manager/packages
|
pipx install project-manager -i https://git.shmyga.ru/api/packages/InfernalGames/pypi/simple/ --pip-args="--extra-index-url https://pypi.org/simple"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -14,17 +22,16 @@ pipx install project-manager -i https://git.shmyga.ru/InfernalGames/project-mana
|
|||||||
pm [-v] [-vv]
|
pm [-v] [-vv]
|
||||||
```
|
```
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Run task
|
### Run task
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pm <task>[:<tag>] [-v] [-vv]
|
pm <task>[:<tag>][:<sub_tag>] [-v] [-vv]
|
||||||
```
|
```
|
||||||
|
|
||||||
## Presets locations
|

|
||||||
|

|
||||||
- default presets [`project_manager/preset/default/*.toml`](./project_manager/preset/default)
|
|
||||||
- user preset `$HOME/.pm.toml`
|
|
||||||
- project preset `./.pm.toml`
|
|
||||||
|
|
||||||
## Preset format
|
## Preset format
|
||||||
|
|
||||||
@@ -39,3 +46,9 @@ commands = ["<command>"]
|
|||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
[Default presets](./project_manager/preset/default)
|
[Default presets](./project_manager/preset/default)
|
||||||
|
|
||||||
|
## Presets locations
|
||||||
|
|
||||||
|
- default presets [`project_manager/preset/default/*.toml`](./project_manager/preset/default)
|
||||||
|
- user preset `$HOME/.pm.toml`
|
||||||
|
- project preset `./.pm.toml`
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 106 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
Reference in New Issue
Block a user