diff --git a/docs/man/antler-proj.1 b/docs/man/antler-proj.1 new file mode 100644 index 0000000..183f902 --- /dev/null +++ b/docs/man/antler-proj.1 @@ -0,0 +1,165 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "antler\-proj" "1" "March 09, 2023" "antler\-proj 1.0.0" "User Manual" +.hy +.SH NAME +.PP +antler\-proj \- Antler Project Management System +.SH SYNOPSIS +.PP +\f[C]antler\-proj []\f[R] +.SH DESCRIPTION +.PP +\f[B]Antler Project Management System\f[R] is a set of libraries and +tools to help users successfully develop smart contracts. +.SH COMMANDS +.PP +This is a general help text which prints when antler\-proj runs without +a command or with key \[en]help. +.PP +\f[B]Example: antler\-proj \[en]help\f[R] +.PP +Each command has its own help which prints when the command runs with +key \[en]help. +.PP +\f[B]Example: antler\-proj init \[en]help\f[R] +.PP +Below is described a full list of all possible commands and their +possible arguments +.PP +\f[B]init\f[R] command creates a new project. +Creating the directory tree, a \f[C]project.yaml\f[R] file and +initializes it. +.IP +.nf +\f[C] +Command arguments: + Path to the root of the project. Here a \[ga]project.yaml\[ga] file will be created + Name of the project + [version] Version of the project. Default version is 0.0.1 + \-h,\-\-help Print this help message and exit + \-p Path to the root of the project. + \-n The name of the project. + \-v The version to store in the project file. +\f[R] +.fi +.PP +\f[B]Example: antler\-proj init ./project hello_world 0.1\f[R] +.PP +\f[B]add\f[R] command adds an app, dependency, library or test to your +project. +.IP +.nf +\f[C] +Command arguments: + \-h,\-\-help Print this help message and exit + \-p This must be the path to the \[ga]project.yml\[ga] or the path containing it. + [path] Path to the root of the project. + Type of an entity to work with +\f[R] +.fi +.PP +\f[B]Example: antler\-proj add ./project app\f[R] +.PP +\f[B]update\f[R] command updates an app, dependency, library or test to +your project. +.IP +.nf +\f[C] +Command arguments: + \-h,\-\-help Print this help message and exit + \-p This must be the path to the \[ga]project.yml\[ga] or the path containing it. + [path] Path to the root of the project. + Type of an entity to work with +\f[R] +.fi +.PP +\f[B]Example: antler\-proj update ./project app\f[R] +.PP +\f[B]remove\f[R] command removes an app, dependency, library or test +from your project. +.IP +.nf +\f[C] +Command arguments: + \-h,\-\-help Print this help message and exit + \-p This must be the path to the \[ga]project.yml\[ga] or the path containing it. + [path] Path to the root of the project. + Type of an entity to work with +\f[R] +.fi +.PP +\f[B]Example: antler\-proj remove ./project app\f[R] +.PP +\f[B]populate\f[R] command loads existing information about the project +starting from the root project.yaml file as described in the chapter +\f[C]\[dq]Loading of a project\[dq]\f[R] in the User\[cq]s guide. +.IP +.nf +\f[C] +Without additional keys it passes through a subtree of each application and checks all non\-local dependencies for updates. +Downloads all the updates in a way depending on where it is located. +\f[R] +.fi +.IP +.nf +\f[C] +Command arguments: + \-h,\-\-help Print this help message and exit + \-p This must be the path to the \[ga]project.yml\[ga] or the path containing it. + [path] Path to the root of the project. +\f[R] +.fi +.PP +\f[B]Example: antler\-proj populate ./project\f[R] +.PP +\f[B]validate\f[R] command performs a check of the project to ensure +that all data that describes the project is correct. +.IP +.nf +\f[C] +Check all project.yaml files described in the project for updates. +Download the updated project.yaml files. +Perform all checks of the project as described in the user\[aq]s guide. +Check if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies +exist and if it is possible to download all remote dependencies. +\f[R] +.fi +.IP +.nf +\f[C] +Command arguments: + \-h,\-\-help Print this help message and exit + \-p Path to the root of the project. + \-V,\-\-verbose Verbose output. +\f[R] +.fi +.PP +\f[B]Example: antler\-proj validate ./project\f[R] +.PP +\f[B]build\f[R] command builds all applications described in the +project.yaml, their dependencies and tests. +.IP +.nf +\f[C] +Command arguments: + \-h,\-\-help Print this help message and exit + \-p This must be the path to the \[ga]project.yml\[ga] or the path containing it. + [path] Path to the root of the project. +\f[R] +.fi +.PP +\f[B]Example: antler\-proj build ./project\f[R] +.PP +\f[B]version\f[R] Returns the version of antler\-proj application +\f[B]Example: antler\-proj version\f[R] +.SH EXAMPLES +.SH AUTHORS +.SH BUGS +.PP +Please submit bug reports online at: + +.SH SEE ALSO +.PP +Full documentation and sources at: + diff --git a/docs/man/antler-proj.1.md b/docs/man/antler-proj.1.md new file mode 100644 index 0000000..a04bad0 --- /dev/null +++ b/docs/man/antler-proj.1.md @@ -0,0 +1,135 @@ +--- +title: antler-proj +section: 1 +header: User Manual +footer: antler-proj 1.0.0 +date: March 09, 2023 +--- +# NAME +antler-proj - Antler Project Management System + +# SYNOPSIS + +`antler-proj []` + +# DESCRIPTION + +**Antler Project Management System** is a set of libraries and tools to help users successfully develop smart contracts. + +# COMMANDS + +This is a general help text which prints when antler-proj runs without a command or with key --help. + +**Example: antler-proj --help** + +Each command has its own help which prints when the command runs with key --help. + +**Example: antler-proj init --help** + +Below is described a full list of all possible commands and their possible arguments + +**init** command creates a new project. Creating the directory tree, a `project.yaml` file and initializes it. + +``` +Command arguments: + Path to the root of the project. Here a `project.yaml` file will be created + Name of the project + [version] Version of the project. Default version is 0.0.1 + -h,--help Print this help message and exit + -p Path to the root of the project. + -n The name of the project. + -v The version to store in the project file. +``` +**Example: antler-proj init ./project hello_world 0.1** + + +**add** command adds an app, dependency, library or test to your project. + +``` +Command arguments: + -h,--help Print this help message and exit + -p This must be the path to the `project.yml` or the path containing it. + [path] Path to the root of the project. + Type of an entity to work with +``` +**Example: antler-proj add ./project app** + + +**update** command updates an app, dependency, library or test to your project. + +``` +Command arguments: + -h,--help Print this help message and exit + -p This must be the path to the `project.yml` or the path containing it. + [path] Path to the root of the project. + Type of an entity to work with +``` +**Example: antler-proj update ./project app** + + +**remove** command removes an app, dependency, library or test from your project. + +``` +Command arguments: + -h,--help Print this help message and exit + -p This must be the path to the `project.yml` or the path containing it. + [path] Path to the root of the project. + Type of an entity to work with +``` +**Example: antler-proj remove ./project app** + + +**populate** command loads existing information about the project starting from the root project.yaml file as described in the chapter `"Loading of a project"` in the User's guide. + + Without additional keys it passes through a subtree of each application and checks all non-local dependencies for updates. + Downloads all the updates in a way depending on where it is located. + +``` +Command arguments: + -h,--help Print this help message and exit + -p This must be the path to the `project.yml` or the path containing it. + [path] Path to the root of the project. +``` +**Example: antler-proj populate ./project** + +**validate** command performs a check of the project to ensure that all data that describes the project is correct. + + Check all project.yaml files described in the project for updates. + Download the updated project.yaml files. + Perform all checks of the project as described in the user's guide. + Check if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies + exist and if it is possible to download all remote dependencies. + +``` +Command arguments: + -h,--help Print this help message and exit + -p Path to the root of the project. + -V,--verbose Verbose output. +``` +**Example: antler-proj validate ./project** + +**build** command builds all applications described in the project.yaml, their dependencies and tests. + +``` +Command arguments: + -h,--help Print this help message and exit + -p This must be the path to the `project.yml` or the path containing it. + [path] Path to the root of the project. +``` +**Example: antler-proj build ./project** + + +**version** Returns the version of antler-proj application +**Example: antler-proj version** + +# EXAMPLES + +# AUTHORS + +# BUGS +Please submit bug reports online at: + +# SEE ALSO +Full documentation and sources at: + + diff --git a/docs/man/make_man.sh b/docs/man/make_man.sh new file mode 100755 index 0000000..4ad2df1 --- /dev/null +++ b/docs/man/make_man.sh @@ -0,0 +1,3 @@ +#!/bin/sh + +pandoc antler-proj.1.md -s -t man -o antler-proj.1 \ No newline at end of file diff --git a/docs/usecases.md b/docs/usecases.md index 33d0b19..357c9de 100644 --- a/docs/usecases.md +++ b/docs/usecases.md @@ -291,8 +291,7 @@ removing the build for now. depends: - name: "lib1" - name: "generic" - lang: "C++" - version: 1 + ```