diff --git a/README.md b/README.md index fdb7a45c..c5033d4a 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,19 @@ gitlit /home/s2/myApp ``` If no folder is specified, gitlit looks at the current path. + +## contribute + +The code is very easy. Just clone the repo and have look! +Use the `.jscrc` for formatting the code and keep it clean and consistent. + +There are just some js libraries: +- [ejs](https://ejs.co/) is used for templating. The templates are in `app/js/templates.js`. +- [sorttable.js](http://www.kryogenix.org/code/browser/sorttable/) to sort the table containing th files. +- [jQuery](https://jquery.com/), because it's still cool to have it, even if everyone says it's dead and we should do without. +- [bootstrap](https://getbootstrap.com/) for the layout +- [PNotify](https://github.com/sciactive/pnotify) for generic notifications + +## license + +ISC