Added a 'Features' subsection to the Readme. Already included some features that Gitar will offer, including 'No JavaScript required'. Yes, it's 2016, and sadly, that's a feature nowadays.
- Author
- Vngngdn
- Date
- Sept. 8, 2016, 9:07 p.m.
- Hash
- 1df9a48f7cdf7c9b80cb0c346167011f9b2baa97
- Parent
-
289e3c93312b178e3a408ca09ae1295d823a1499
- Modified file
- README.md
README.md ¶
8 additions and 0 deletions.
View changes Hide changes
1 |
1 |
===== |
2 |
2 |
|
3 |
3 |
Gitar is a free/libre, gratis, lightweight, easy to deploy web app for storing information about |
4 |
4 |
desired Git repositories for Django powered web servers. |
5 |
5 |
|
6 |
6 |
Name |
7 |
7 |
---- |
8 |
8 |
|
9 |
9 |
Gitar refers to the fact that the software is built for Git repositories, for |
10 |
10 |
use with the [Django web framework](https://djangoproject.com). Django itself |
11 |
11 |
refers to the name of the guitarist [Django |
12 |
12 |
Reinhardt](https://en.wikipedia.org/wiki/Django_Reinhardt). So I found "Gitar" |
13 |
13 |
an awesome name =3 |
14 |
14 |
|
15 |
15 |
About |
16 |
16 |
----- |
17 |
17 |
|
18 |
18 |
Gitar adheres to Django's MVT structure, and was built to allow people to easily |
19 |
19 |
refer to their Git repos, providing readable code in the background, with |
20 |
20 |
templates implementing Google's [Material Design |
21 |
21 |
specifications](https://www.google.com/design/spec). |
22 |
22 |
|
23 |
23 |
Another reason Gitar was meant to happen, is because of Github's rather |
24 |
24 |
hypocritic approach to its own existence; while it hosts an amazing amount of |
25 |
25 |
[free](https://audio-video.gnu.org/video/TEDxGE2014_Stallman05_LQ.webm) |
26 |
26 |
software, GitHub Inc. does not share GitHub's code at all ([I'm not the only one |
27 |
27 |
that dislikes this](https://github.com/dear-github/dear-github)). Gitar tries to |
28 |
28 |
fix that (and hopefully more). |
29 |
29 |
|
30 |
30 |
Gitar's repo handling consists mainly of read-only features, but I hope I can |
31 |
31 |
expand Gitar in such a way, that it becomes a viable alternative to Github's |
32 |
32 |
offerings. |
33 |
33 |
|
34 |
34 |
Gitar was also made because I wanted to make a serious project with a punny name =) |
35 |
35 |
|
36 |
36 |
Supported databases |
| + |
37 |
-------- |
| + |
38 |
|
| + |
39 |
* Simple and lightweight |
| + |
40 |
* Source code syntax highlighting using Pygments |
| + |
41 |
* No JavaScript required |
| + |
42 |
* Free/Libre software |
| + |
43 |
|
| + |
44 |
Supported databases |
37 |
45 |
---------------- |
38 |
46 |
|
39 |
47 |
Currently, Gitar only supports PostgreSQL databases. However, the parts that |
40 |
48 |
make it a Postgres-exclusive program are extremely small, allowing for easy |
41 |
49 |
refactoring of the code, in order to support other databases. If enough people |
42 |
50 |
ask for extended database support, I'll be happy to normalize the database in |
43 |
51 |
order to allow for less cool options like MySQL. |
44 |
52 |
|
45 |
53 |
Licensing |
46 |
54 |
--------- |
47 |
55 |
|
48 |
56 |
Gitar is free software, licensed under the GNU Affero General Public License |
49 |
57 |
v3+. |
50 |
58 |