Commit f4d69f35 authored by Bat's avatar Bat
Browse files

Doc: commands and variables

parent 725fd947
Pipeline #10112 passed with stages
in 6 minutes and 40 seconds
......@@ -99,15 +99,16 @@ The Vala version to use with this project.
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.
`<arg>` is a mandatory argument.
`[arg]` is an optional argument.
### search <package>
### search package
Search the package named `package` in the known repositories. It will display something like that.
......@@ -116,7 +117,7 @@ package 0.1.0 Short description of the package.
other 0.2.3 Yet another package.
```
### info <package>
### info package
Gives infos about `package`.
......@@ -139,15 +140,68 @@ 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)
### publish <major|minor|patch> --repo <url> [--no-changelog]
### 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`.
### build [--release]
Compiles your project using the options specified in the manifest.
### gen output --template template
Creates a new file (`output`) from the template named `template`. `output` doesn't need to include any extension.
### help [command]
Gives you help about poulp, or a specific command if `command` is specified.
### init
An interactive tool to create a new project.
### install [lib] [lib] [lib]...
Install all the specified libraries, or those present in `libs` in the manifest if none.
### lint [--elementary|--gnome|--both]
Lints your code, following the specified convention (defautl is elementary).
### repo [add|remove] [url]
Manages your remote repositories. If there is no argument, it just lists them.
If you do [add url], it registers the repo at `url`. And `remove url` unregisters the repository at `url`.
### run script
It runs the script named `script`, previousy defined in the manifest.
### update [lib] [lib] [lib]...
Updates your packages to the latest version.
# Variables
poulp defines some environment varaibles when spawning a command. You can use them in `output`, `compilerParams` and your scripts.
- `$PROJECT_NAME`, the name of your project;
- `$PROJECT_VERSION`, the version of your project;
- `$PROJECT_DESCRIPTION`, the description of your project;
- `$PROJECT_LICENSE`, the license of your project;
- `$PROJECT_HOMEPAGE`, the homepage of your project;
- `$PROJECT_OUTPUT`, the path to the output of your project;
# 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