Skip to content

Commit 6369bda

Browse files
committed
Cleaning up the readme
1 parent 70c474e commit 6369bda

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Build status:
66
[![PyPi](https://img.shields.io/pypi/pyversions/CodeManager)](https://pypi.org/project/CodeManager/)
77
[![PyPi](https://img.shields.io/pypi/v/CodeManager)](https://pypi.org/project/CodeManager/)
88

9+
![img](./logo.png)
910

10-
# Code Manager
1111

12-
![img](./logo.png)
12+
# Code Manager
1313

1414

1515
## Abstract
@@ -98,10 +98,10 @@ The file contains all of the relevant information needed to install a certain pa
9898
"base": "git@github.com:palikar"
9999
},
100100

101-
"packages_list": [
101+
"packages_list": {
102102
"group_1" : ["package_1_1", "package_2_1"],
103103
"group_2" : ["package_1_2", "package_2_2"]
104-
],
104+
},
105105

106106
"debian_packages": [
107107
"group_1" : ["deb_package_1_1", "deb_package_2_1"],
@@ -115,11 +115,10 @@ The file contains all of the relevant information needed to install a certain pa
115115
"url" : "...."
116116
},
117117
"install" : ["cmake", "command", "make"],
118-
"make_args": "-j4"
118+
"make_args": "-j4",
119119
"make_extra_targets": [],
120120
"command" : "echo Ruuning some command"
121-
},
122-
121+
}
123122
}
124123
```
125124

@@ -143,9 +142,9 @@ At the start of the file, the `vars` node defines several “variables&rdquo
143142

144143
```json
145144
"git" : {
146-
"url" : "url for the git clone command",
147-
"checkout": "optional commit ID that will be checked out to"
148-
"args" : "optional extra artuments for the git clone command"
145+
"url": "url for the git clone command",
146+
"checkout": "optional commit ID that will be checked out to",
147+
"args": "optional extra artuments for the git clone command"
149148
}
150149
```
151150

README.org

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ Build status:
2525
[![PyPi](https://img.shields.io/pypi/v/CodeManager)](https://pypi.org/project/CodeManager/)
2626
#+END_EXAMPLE
2727

28-
* Code Manager
2928
[[./logo.png]]
3029

30+
* Code Manager
31+
3132
** Abstract
3233

3334
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,10 +114,10 @@ The file contains all of the relevant information needed to install a certain pa
113114
"base": "git@github.com:palikar"
114115
},
115116

116-
"packages_list": [
117+
"packages_list": {
117118
"group_1" : ["package_1_1", "package_2_1"],
118119
"group_2" : ["package_1_2", "package_2_2"]
119-
],
120+
},
120121

121122
"debian_packages": [
122123
"group_1" : ["deb_package_1_1", "deb_package_2_1"],
@@ -130,11 +131,10 @@ The file contains all of the relevant information needed to install a certain pa
130131
"url" : "...."
131132
},
132133
"install" : ["cmake", "command", "make"],
133-
"make_args": "-j4"
134+
"make_args": "-j4",
134135
"make_extra_targets": [],
135136
"command" : "echo Ruuning some command"
136-
},
137-
137+
}
138138
}
139139
#+END_SRC
140140

@@ -157,9 +157,9 @@ At the start of the file, the ~vars~ node defines several "variables" that later
157157
~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:
158158
#+BEGIN_SRC json
159159
"git" : {
160-
"url" : "url for the git clone command",
161-
"checkout": "optional commit ID that will be checked out to"
162-
"args" : "optional extra artuments for the git clone command"
160+
"url": "url for the git clone command",
161+
"checkout": "optional commit ID that will be checked out to",
162+
"args": "optional extra artuments for the git clone command"
163163
}
164164
#+END_SRC
165165
If ~curl~ is executed the package object must contain a curl node:

0 commit comments

Comments
 (0)