docs: some details
This commit is contained in:
parent
247e653ba3
commit
a28e7b57a2
1 changed files with 38 additions and 1 deletions
37
README.md
37
README.md
|
@ -8,3 +8,40 @@
|
|||
> ***Almost to a point you can use it*** :)
|
||||
|
||||
Packager is a simple yet powerful package manager
|
||||
|
||||
## Install a package
|
||||
pkgr supports fetching packages with a:
|
||||
- path
|
||||
- url (http/https)
|
||||
- package locator
|
||||
|
||||
```shell
|
||||
# example with path
|
||||
pkgr install ./foxy/snek.pkg
|
||||
# example with url
|
||||
pkgr install https://example.com/doggo.pkg
|
||||
# example with package locator
|
||||
pkgr install foo:stable,bar
|
||||
```
|
||||
|
||||
## Composing a package
|
||||
Right now, pkgr does not have a compose/package command. (it's in the works dw!)
|
||||
You can create a package with `pkg.py`!
|
||||
|
||||
```shell
|
||||
# Usage: pkg.py <package_toml_path> <output_path> [<directories_to_include> ...]
|
||||
# example:
|
||||
python pkg.py manifest.toml example.pkg root/ source/ scripts/
|
||||
# this will create a package with an archive that look like this:
|
||||
# [header+manifest]
|
||||
# ...
|
||||
# [archive:
|
||||
# root/
|
||||
# source/
|
||||
# scripts/
|
||||
# ]
|
||||
```
|
||||
|
||||
It's not perfect, but it'll get the job done :)
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue