Eclectic Media Git ptree / master
Added documentation overview Ariana Giroux 1 year, 8 months ago
3 changed file(s) with 41 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 Authors
1 =======
2
3 :Ariana Giroux: Repository Maintainer
4 :url: http://arianagiroux.ca
5 :twitter: @ArianaGiroux
6 :email: me@arianagiroux.ca:
0 Copyright 2019, Ariana Giroux <me@arianagiroux.ca>
1
2 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3
4 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5
6 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0 Installation
1 ============
2
3 First clone this repository and change directory to its base:
4 ::
5
6 $ git clone https://gitlab.com/eclectickmediasolutions/ptree.git ptree
7 $ cd ptree
8
9 All installation can be handled with ``pip``:
10 ::
11
12 $ pip install .
13
14
15 Running the Software
16 ====================
17
18 To run the software after installation, simply run the following:
19 ::
20
21 $ ptree
22
23 For a full list of options and what they do, check:
24 ::
25
26 $ ptree -h