Skip to content

Commit

Permalink
Cleaning up the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
palikar committed Nov 17, 2019
1 parent 70c474e commit e6607b8
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 23 deletions.
23 changes: 11 additions & 12 deletions README.md
Expand Up @@ -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
Expand Down Expand Up @@ -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": {
Expand All @@ -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"
},

}
}
```

Expand All @@ -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"
}
```

Expand Down
22 changes: 11 additions & 11 deletions README.org
Expand Up @@ -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.
Expand Down Expand Up @@ -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": {
Expand All @@ -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

Expand All @@ -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:
Expand Down

0 comments on commit e6607b8

Please sign in to comment.