From 8d7a7f69d2ca0eec239108d38c99058766c83be6 Mon Sep 17 00:00:00 2001 From: Alexander Molchevsky Date: Mon, 13 Mar 2023 14:47:31 +0200 Subject: [PATCH 1/3] Addede a man page --- docs/man/antler-proj.1 | 165 ++++++++++++++++++++++++++++++++++++++ docs/man/antler-proj.1.md | 135 +++++++++++++++++++++++++++++++ docs/man/make_man.sh | 3 + docs/usecases.md | 3 +- 4 files changed, 304 insertions(+), 2 deletions(-) create mode 100644 docs/man/antler-proj.1 create mode 100644 docs/man/antler-proj.1.md create mode 100755 docs/man/make_man.sh diff --git a/docs/man/antler-proj.1 b/docs/man/antler-proj.1 new file mode 100644 index 0000000..cd47436 --- /dev/null +++ b/docs/man/antler-proj.1 @@ -0,0 +1,165 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "aproj" "1" "March 09, 2023" "aproj 1.0.0" "User Manual" +.hy +.SH NAME +.PP +aproj \- Antler Project Management System +.SH SYNOPSIS +.PP +\f[C]aproj []\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 aproj runs without a +command or with key \[en]help. +.PP +\f[B]Example: aproj \[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: aproj 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 +initialize 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: aproj init ./project hello_world 0.1\f[R] +.PP +\f[B]add\f[R] command add 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: aproj 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: aproj update ./project app\f[R] +.PP +\f[B]remove\f[R] command remove 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: aproj remove ./project app\f[R] +.PP +\f[B]populate\f[R] command Load existing information about the project +starting from the root project.yaml file as it described in 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 pass through a subtree of each application and check 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: aproj 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. +Do all checks of the project as described in the user\[aq]s guide. +Checks 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: aproj validate ./project\f[R] +.PP +\f[B]build\f[R] command do building of 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: aproj build ./project\f[R] +.PP +\f[B]version\f[R] Returns the version of antler\-proj application +\f[B]Example: aproj 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..4f24e6b --- /dev/null +++ b/docs/man/antler-proj.1.md @@ -0,0 +1,135 @@ +--- +title: aproj +section: 1 +header: User Manual +footer: aproj 1.0.0 +date: March 09, 2023 +--- +# NAME +aproj - Antler Project Management System + +# SYNOPSIS + +`aproj []` + +# 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 aproj runs without a command or with key --help. + +**Example: aproj --help** + +Each command has its own help which prints when the command runs with key --help. + +**Example: aproj 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 initialize 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: aproj init ./project hello_world 0.1** + + +**add** command add 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: aproj 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: aproj update ./project app** + + +**remove** command remove 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: aproj remove ./project app** + + +**populate** command Load existing information about the project starting from the root project.yaml file as it described in chapter `"Loading of a project"` in the User's guide. + + Without additional keys it pass through a subtree of each application and check 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: aproj 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. + Do all checks of the project as described in the user's guide. + Checks 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: aproj validate ./project** + +**build** command do building of 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: aproj build ./project** + + +**version** Returns the version of antler-proj application +**Example: aproj 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 + ``` From e0bcdbc9c66b275043f4b9814164e2c02dbfa69f Mon Sep 17 00:00:00 2001 From: Alexander Molchevsky Date: Mon, 20 Mar 2023 17:03:59 +0200 Subject: [PATCH 2/3] changed aproj to antler-proj --- docs/man/antler-proj.1 | 30 +++++++++++++++--------------- docs/man/antler-proj.1.md | 30 +++++++++++++++--------------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/man/antler-proj.1 b/docs/man/antler-proj.1 index cd47436..c463664 100644 --- a/docs/man/antler-proj.1 +++ b/docs/man/antler-proj.1 @@ -1,28 +1,28 @@ .\" Automatically generated by Pandoc 2.5 .\" -.TH "aproj" "1" "March 09, 2023" "aproj 1.0.0" "User Manual" +.TH "antler\-proj" "1" "March 09, 2023" "antler\-proj 1.0.0" "User Manual" .hy .SH NAME .PP -aproj \- Antler Project Management System +antler\-proj \- Antler Project Management System .SH SYNOPSIS .PP -\f[C]aproj []\f[R] +\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 aproj runs without a -command or with key \[en]help. +This is a general help text which prints when antler\-proj runs without +a command or with key \[en]help. .PP -\f[B]Example: aproj \[en]help\f[R] +\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: aproj init \[en]help\f[R] +\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 @@ -44,7 +44,7 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj init ./project hello_world 0.1\f[R] +\f[B]Example: antler\-proj init ./project hello_world 0.1\f[R] .PP \f[B]add\f[R] command add an app, dependency, library or test to your project. @@ -59,7 +59,7 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj add ./project app\f[R] +\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. @@ -74,7 +74,7 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj update ./project app\f[R] +\f[B]Example: antler\-proj update ./project app\f[R] .PP \f[B]remove\f[R] command remove an app, dependency, library or test to your project. @@ -89,7 +89,7 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj remove ./project app\f[R] +\f[B]Example: antler\-proj remove ./project app\f[R] .PP \f[B]populate\f[R] command Load existing information about the project starting from the root project.yaml file as it described in chapter @@ -111,7 +111,7 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj populate ./project\f[R] +\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. @@ -135,7 +135,7 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj validate ./project\f[R] +\f[B]Example: antler\-proj validate ./project\f[R] .PP \f[B]build\f[R] command do building of all applications described in the project.yaml, their dependencies and tests. @@ -149,10 +149,10 @@ Command arguments: \f[R] .fi .PP -\f[B]Example: aproj build ./project\f[R] +\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: aproj version\f[R] +\f[B]Example: antler\-proj version\f[R] .SH EXAMPLES .SH AUTHORS .SH BUGS diff --git a/docs/man/antler-proj.1.md b/docs/man/antler-proj.1.md index 4f24e6b..689524d 100644 --- a/docs/man/antler-proj.1.md +++ b/docs/man/antler-proj.1.md @@ -1,16 +1,16 @@ --- -title: aproj +title: antler-proj section: 1 header: User Manual -footer: aproj 1.0.0 +footer: antler-proj 1.0.0 date: March 09, 2023 --- # NAME -aproj - Antler Project Management System +antler-proj - Antler Project Management System # SYNOPSIS -`aproj []` +`antler-proj []` # DESCRIPTION @@ -18,13 +18,13 @@ aproj - Antler Project Management System # COMMANDS -This is a general help text which prints when aproj runs without a command or with key --help. +This is a general help text which prints when antler-proj runs without a command or with key --help. -**Example: aproj --help** +**Example: antler-proj --help** Each command has its own help which prints when the command runs with key --help. -**Example: aproj init --help** +**Example: antler-proj init --help** Below is described a full list of all possible commands and their possible arguments @@ -40,7 +40,7 @@ Command arguments: -n The name of the project. -v The version to store in the project file. ``` -**Example: aproj init ./project hello_world 0.1** +**Example: antler-proj init ./project hello_world 0.1** **add** command add an app, dependency, library or test to your project. @@ -52,7 +52,7 @@ Command arguments: [path] Path to the root of the project. Type of an entity to work with ``` -**Example: aproj add ./project app** +**Example: antler-proj add ./project app** **update** command updates an app, dependency, library or test to your project. @@ -64,7 +64,7 @@ Command arguments: [path] Path to the root of the project. Type of an entity to work with ``` -**Example: aproj update ./project app** +**Example: antler-proj update ./project app** **remove** command remove an app, dependency, library or test to your project. @@ -76,7 +76,7 @@ Command arguments: [path] Path to the root of the project. Type of an entity to work with ``` -**Example: aproj remove ./project app** +**Example: antler-proj remove ./project app** **populate** command Load existing information about the project starting from the root project.yaml file as it described in chapter `"Loading of a project"` in the User's guide. @@ -90,7 +90,7 @@ Command arguments: -p This must be the path to the `project.yml` or the path containing it. [path] Path to the root of the project. ``` -**Example: aproj populate ./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. @@ -106,7 +106,7 @@ Command arguments: -p Path to the root of the project. -V,--verbose Verbose output. ``` -**Example: aproj validate ./project** +**Example: antler-proj validate ./project** **build** command do building of all applications described in the project.yaml, their dependencies and tests. @@ -116,11 +116,11 @@ Command arguments: -p This must be the path to the `project.yml` or the path containing it. [path] Path to the root of the project. ``` -**Example: aproj build ./project** +**Example: antler-proj build ./project** **version** Returns the version of antler-proj application -**Example: aproj version** +**Example: antler-proj version** # EXAMPLES From a79b8c55edaf3dcc4baa58b3d45c1256c3eb8536 Mon Sep 17 00:00:00 2001 From: Michal Lesiak Date: Tue, 28 Mar 2023 15:41:41 +0200 Subject: [PATCH 3/3] Minor grammatical corrections --- docs/man/antler-proj.1 | 20 ++++++++++---------- docs/man/antler-proj.1.md | 16 ++++++++-------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/man/antler-proj.1 b/docs/man/antler-proj.1 index c463664..183f902 100644 --- a/docs/man/antler-proj.1 +++ b/docs/man/antler-proj.1 @@ -29,7 +29,7 @@ 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 -initialize it. +initializes it. .IP .nf \f[C] @@ -46,7 +46,7 @@ Command arguments: .PP \f[B]Example: antler\-proj init ./project hello_world 0.1\f[R] .PP -\f[B]add\f[R] command add an app, dependency, library or test to your +\f[B]add\f[R] command adds an app, dependency, library or test to your project. .IP .nf @@ -76,8 +76,8 @@ Command arguments: .PP \f[B]Example: antler\-proj update ./project app\f[R] .PP -\f[B]remove\f[R] command remove an app, dependency, library or test to -your project. +\f[B]remove\f[R] command removes an app, dependency, library or test +from your project. .IP .nf \f[C] @@ -91,13 +91,13 @@ Command arguments: .PP \f[B]Example: antler\-proj remove ./project app\f[R] .PP -\f[B]populate\f[R] command Load existing information about the project -starting from the root project.yaml file as it described in chapter +\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 pass through a subtree of each application and check all non local dependencies for updates. +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 @@ -120,8 +120,8 @@ that all data that describes the project is correct. \f[C] Check all project.yaml files described in the project for updates. Download the updated project.yaml files. -Do all checks of the project as described in the user\[aq]s guide. -Checks if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies +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 @@ -137,7 +137,7 @@ Command arguments: .PP \f[B]Example: antler\-proj validate ./project\f[R] .PP -\f[B]build\f[R] command do building of all applications described in the +\f[B]build\f[R] command builds all applications described in the project.yaml, their dependencies and tests. .IP .nf diff --git a/docs/man/antler-proj.1.md b/docs/man/antler-proj.1.md index 689524d..a04bad0 100644 --- a/docs/man/antler-proj.1.md +++ b/docs/man/antler-proj.1.md @@ -28,7 +28,7 @@ Each command has its own help which prints when the command runs with key --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 initialize it. +**init** command creates a new project. Creating the directory tree, a `project.yaml` file and initializes it. ``` Command arguments: @@ -43,7 +43,7 @@ Command arguments: **Example: antler-proj init ./project hello_world 0.1** -**add** command add an app, dependency, library or test to your project. +**add** command adds an app, dependency, library or test to your project. ``` Command arguments: @@ -67,7 +67,7 @@ Command arguments: **Example: antler-proj update ./project app** -**remove** command remove an app, dependency, library or test to your project. +**remove** command removes an app, dependency, library or test from your project. ``` Command arguments: @@ -79,9 +79,9 @@ Command arguments: **Example: antler-proj remove ./project app** -**populate** command Load existing information about the project starting from the root project.yaml file as it described in chapter `"Loading of a project"` in the User's guide. +**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 pass through a subtree of each application and check all non local dependencies for updates. + 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. ``` @@ -96,8 +96,8 @@ Command arguments: Check all project.yaml files described in the project for updates. Download the updated project.yaml files. - Do all checks of the project as described in the user's guide. - Checks if it is possible to access all dependencies. I.e. if all described local directories of all local dependencies + 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. ``` @@ -108,7 +108,7 @@ Command arguments: ``` **Example: antler-proj validate ./project** -**build** command do building of all applications described in the project.yaml, their dependencies and tests. +**build** command builds all applications described in the project.yaml, their dependencies and tests. ``` Command arguments: