Commit ea32e52e authored by Baptiste CHOCOT's avatar Baptiste CHOCOT
Browse files

update readme for 1.2.4

parent fbe9b9d3
Introduction
============
# ActEV CLI README
## Introduction
Consult the documentation to learn more about the CLI: [introduction](doc/introduction.md)
......@@ -10,12 +11,9 @@ This repository contains:
You should fork the project and use the `master` branch in order to implement the entry point methods and get the updates.
Test it
============
## Test it
Get the CLI
-----------
### Get the CLI
**Requirements:** python > 3.7
......@@ -25,8 +23,7 @@ Clone the repository:
git clone https://gitlab.kitware.com/actev/diva_evaluation_cli.git
```
Install it
----------
### Install it
* Go into the clone of this repository:
......@@ -44,8 +41,7 @@ See `diva_evaluation_cli/bin/install.sh -h` for more options. If using `--all`,
N.B.: We recommend to set the `-c` and `-s` options to what will be used as `system_cache_dir` by the entry_points ; otherwise, some operations like `validate-execution` will likely fail.
Test the installation
---------------------
### Test the installation
Run the following command:
......@@ -55,12 +51,9 @@ actev
You should be able to see the available subcommands.
Usage
=====
## Usage
Command line
------------
### Command line
Run the following command to obtain help with the CLI:
......@@ -68,17 +61,13 @@ Run the following command to obtain help with the CLI:
actev -h
```
Documentation
-------------
### Documentation
Consult the documentation to have information: [CLI](doc/cli_commands/index.md)
Fork it and develop your own implementation
## Fork it and develop your own implementation
===========================================
Fork it
-------
### Fork it
Click on the “Fork” button to make a copy of the repository in your own space and add this repository as a remote upstream to get the latest updates
......@@ -86,8 +75,7 @@ Click on the “Fork” button to make a copy of the repository in your own spac
git remote add upstream https://gitlab.kitware.com/actev/diva_evaluation_cli.git
```
Update it
---------
### Update it
Execute the following commands to update it:
......@@ -97,17 +85,20 @@ git checkout master
git rebase upstream/master
```
Develop it
----------
### Develop it
The CLI components are included in the `bin` directory, you do not have to modify it.
To add your code, you simply have to implement the methods in `src/entry_points`.
The CLI components are included in the `bin` directory, you do not have to modify it.
To add your code, you simply have to implement the methods in `src/entry_points`.
We suggest you to call your scripts in the entry point methods and store them in `src`.
We suggest you to call your scripts in the entry point methods and store them in `src`.
More information about the development and the update of the CLI here: [development](doc/development.md)
Contact
:warning: Since release 1.2.4, we made sure the content of `/bin` from **your** CLI will be ignored. For example, if you used to edit `/bin/install.sh`, your submissions will likely fail from now. The best way is to move this kind of files/scripts into entry-points `actev-experiment-init` and/or `actev-system-setup`.
:warning: Since release 1.2.4, the CLI installation supports [conda](https://docs.conda.io/en/latest/) environments. This is now the default way for installing the CLI dependencies, **however if you wish to stick with `pip`, you will have to remove `environment.yml` from your CLI.
:warning: Since release 1.2.4, the entry-point `validate-system` requires the existence of a `LICENSE.txt` file at the root of your project.
=======
## Contact
* diva-nist@nist.gov
Supports Markdown
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