Commit 725fd947 authored by Bat's avatar Bat

Doc: manifest fields

parent 5150feed
Pipeline #10111 passed with stages
in 6 minutes and 24 seconds
......@@ -32,6 +32,73 @@ This key is mandatory.
This is just a short description of your package.
### keywords
An array containing strings, which are the keywords of your package. It help people finding them when doing `poulp search`, and on the repositories websites using [poulp server](https://framagit.org/valse/poulp-server).
### homepage
This is a string containing the URL of the projects website.
### bugs
Specifies where to report bugs. It is an object, which can contain this fields.
- `url`, the bug tracker URL ;
- `email`, an email adress where we can send bug reports.
### license
The name of the license of your project.
### author
The name of the author of the project. It could contain an email adress after the name, between `<` `>`.
### contributors
A list of the peoples (string looking like the `author` field) who contributed to this project.
### maintainers
A list of the peoples (string looking like the `author` field) who maintains this project.
### files
The files to include at compilation.
### repository
The URL of the projects repository, where we can find the source code.
### vapiDir
The path to a directory containing personal VAPIs.
### output
Where to put the result of the compilation. Defaults to `build/name-version` (where `name` is the name of the project and `version` the version).
### scripts
Some custom scripts, that can be run whit `poulp run`. It's an object containing the fields you want (their name will be used as the argument of `poulp run`). Each of those fields are arrays with the list of the command to run.
### libs
The projects dependencies. The name should be the same as the VAPI file name.
### devLibs
Same as `libs`, but will only be installed by people developing the project. For instance, it could a testing framework.
### valaVersion
The Vala version to use with this project.
### compilerParams
Some other arguments to gives to `valac` when building.
## Commands
Each command listed here can be run with `poulp command`, where `command` is the command followed by its arguments.
......@@ -72,6 +139,15 @@ Source code https://john.doe.eu/git/package.git
Creates a .zip or .tar.gz file containing all the binaries of the project (.h, .vapi, .so, .dll, etc)
- pack
- publish
- search
### publish <major|minor|patch> --repo <url> [--no-changelog]
Pack the project (see `pack` below), creates a new version (update it in the manifest, `git tag` if the project uses `git`),
and update the changelog with `git log`, if it was not manually done (this last behavior can be disabled with `--no-changelog`).
Then it post the new version on the repository at `url`.
# Variables
# Remote repositories organization
# Local organization
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment