Changeset - cc971aba64fe
[Not reviewed]
0 1 2
Branko Majic (branko) - 6 years ago 2018-02-27 14:47:37
branko@majic.rs
GC-12: Added initial (dummy) installation and usage instructions.
3 files changed with 66 insertions and 0 deletions:
0 comments (0 inline, 0 general)
docs/index.rst
Show inline comments
 
@@ -23,6 +23,8 @@ Contents
 
   :maxdepth: 2
 

	
 
   about
 
   installation
 
   usage
 
   development
 

	
 

	
docs/installation.rst
Show inline comments
 
new file 100644
 
.. Copyright (C) 2018 Branko Majic
 

	
 
   This file is part of Gimmecert documentation.
 

	
 
   This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
 
   Unported License. To view a copy of this license, visit
 
   http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
 
   Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
 

	
 

	
 
Installation
 
============
 

	
 
Gimmecert can be easily installed using ``pip``. Before installing it,
 
make sure the following requirements have been met:
 

	
 
- You are running *Python 3.4+*.
 

	
 
In order to install latest stable release of *Gimmecert* using *pip*, run the
 
following command::
 

	
 
  pip install gimmecert
 

	
 
In order to install the latest development version of Gimmecert from
 
git repository, use one of the following commands::
 

	
 
  pip install -e git+https://code.majic.rs/gimmecert#egg=gimmecert
 
  pip install -e git+https://github.com/azaghal/gimmecert#egg=gimmecert
docs/usage.rst
Show inline comments
 
new file 100644
 
.. Copyright (C) 2018 Branko Majic
 

	
 
   This file is part of Gimmecert documentation.
 

	
 
   This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
 
   Unported License. To view a copy of this license, visit
 
   http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
 
   Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
 

	
 

	
 
Usage
 
=====
 

	
 
Gimmecert provides a simple and clean CLI interface for all actions.
 

	
 
Description of all available commands, manadatory arguments, and
 
optional arguments is also made available via CLI by either using the
 
help flag (``-h`` / ``--help``) or help command.
 

	
 
Running the tool without any command or argument will output short
 
usage instructions listing available commands.
 

	
 
To get more detailed general help on tool usage, and list of available
 
commands with short description on what they do, run one of the
 
following::
 

	
 
  gimmecert -h
 
  gimmecert --help
 
  gimmecert help
 

	
 
To get more details on specific command, along what mandatory and
 
positional arguments are available, simply provide the help flag when
 
running them. For example::
 

	
 
  gimmecert init -h
 
  gimmecert init --help
0 comments (0 inline, 0 general)