From e6607b8b276c9e270f4d1309f8eb53e0e15cc4f8 Mon Sep 17 00:00:00 2001 From: Stanislav Arnaudov Date: Sun, 17 Nov 2019 22:06:18 +0100 Subject: [PATCH] Cleaning up the readme --- README.md | 23 +++++++++++------------ README.org | 22 +++++++++++----------- 2 files changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 8e7977f..befa87a 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ Build status: [![PyPi](https://img.shields.io/pypi/pyversions/CodeManager)](https://pypi.org/project/CodeManager/) [![PyPi](https://img.shields.io/pypi/v/CodeManager)](https://pypi.org/project/CodeManager/) +![img](./logo.png) -# Code Manager -![img](./logo.png) +# Code Manager ## Abstract @@ -98,15 +98,15 @@ The file contains all of the relevant information needed to install a certain pa "base": "git@github.com:palikar" }, - "packages_list": [ + "packages_list": { "group_1" : ["package_1_1", "package_2_1"], "group_2" : ["package_1_2", "package_2_2"] - ], + }, - "debian_packages": [ + "debian_packages": { "group_1" : ["deb_package_1_1", "deb_package_2_1"], "group_2" : ["deb_package_1_2", "deb_package_2_2"] - ], + }, "packages": { "package_1_1": { @@ -115,11 +115,10 @@ The file contains all of the relevant information needed to install a certain pa "url" : "...." }, "install" : ["cmake", "command", "make"], - "make_args": "-j4" + "make_args": "-j4", "make_extra_targets": [], "command" : "echo Ruuning some command" - }, - + } } ``` @@ -143,9 +142,9 @@ At the start of the file, the `vars` node defines several “variables&rdquo ```json "git" : { - "url" : "url for the git clone command", - "checkout": "optional commit ID that will be checked out to" - "args" : "optional extra artuments for the git clone command" + "url": "url for the git clone command", + "checkout": "optional commit ID that will be checked out to", + "args": "optional extra artuments for the git clone command" } ``` diff --git a/README.org b/README.org index 8172ffc..4f3f508 100644 --- a/README.org +++ b/README.org @@ -25,9 +25,10 @@ Build status: [![PyPi](https://img.shields.io/pypi/v/CodeManager)](https://pypi.org/project/CodeManager/) #+END_EXAMPLE -* Code Manager [[./logo.png]] +* Code Manager + ** Abstract This is my personal tool now for managing my github repositories, some system software that I use and pretty much everything that can be downloaded, compiled locally and then installed on a Debian based Linux system. Through this utility one can quickly download and install random things from all over the internet. I've always wanted some small program that would allow me to quickly bring my github repositories on my local machine so I end it up writing this in my spare time. The program is focused on automation but also on flexibility in the installation process. A lot of software is compiled and installed in some standard way but there are also things that are a little bit trickier. The utility - named appropriately ~code_manager~ - aims to provide a unified interface for the installation process of all types of software -- the trickier kind included. @@ -113,15 +114,15 @@ The file contains all of the relevant information needed to install a certain pa "base": "git@github.com:palikar" }, - "packages_list": [ + "packages_list": { "group_1" : ["package_1_1", "package_2_1"], "group_2" : ["package_1_2", "package_2_2"] - ], + }, - "debian_packages": [ + "debian_packages": { "group_1" : ["deb_package_1_1", "deb_package_2_1"], "group_2" : ["deb_package_1_2", "deb_package_2_2"] - ], + }, "packages": { "package_1_1": { @@ -130,11 +131,10 @@ The file contains all of the relevant information needed to install a certain pa "url" : "...." }, "install" : ["cmake", "command", "make"], - "make_args": "-j4" + "make_args": "-j4", "make_extra_targets": [], "command" : "echo Ruuning some command" - }, - + } } #+END_SRC @@ -157,9 +157,9 @@ At the start of the file, the ~vars~ node defines several "variables" that later ~fetch~ - the fetching method for the package or how it will be downloaded. the field can be either a string or a list of strings. Possible string values are ~git~ \ ~curl~. These can also be given in a list. ~code_manger~ will execute each fetcher in the list or the single fetcher given a string. If the ~git~ fetcher is executed, the package object must also contain a ~git~ node: #+BEGIN_SRC json "git" : { - "url" : "url for the git clone command", - "checkout": "optional commit ID that will be checked out to" - "args" : "optional extra artuments for the git clone command" + "url": "url for the git clone command", + "checkout": "optional commit ID that will be checked out to", + "args": "optional extra artuments for the git clone command" } #+END_SRC If ~curl~ is executed the package object must contain a curl node: