Update README to markdown

This commit is contained in:
Las Zenow 2017-09-21 21:19:06 +00:00
parent c9b967a2ef
commit 6ef8b53d72
2 changed files with 79 additions and 86 deletions

86
README
View file

@ -1,86 +0,0 @@
Imperial Library of Trantor
The Imperial Library of Trantor (also known as Galactic Library) is a repository management system of ebooks on ePub format.
You can check out the main development branch from GitLab at:
https://gitlab.com/trantor/
(We still in pre-beta fase)
== Dependences ==
In order to run Trantor, you need to install the following packages:
* Go language
* Mongodb (>= 2.6)
* Bazaar
* Git
Under Debian Wheezy you can simply run:
# aptitude install golang-go git mercurial bzr mongodb
Yo also need to install go dependences:
# go get gopkg.in/mgo.v2 gopkg.in/mgo.v2/bson github.com/gorilla/sessions \
github.com/gorilla/securecookie github.com/gorilla/mux \
github.com/nfnt/resize github.com/cihub/seelog \
golang.org/x/crypto/scrypt \
github.com/jmhodges/gocld2
== Installation ==
=== For admins ("for developers" below) ===
Now you can install Trantor itself:
# go get gitlab.com/trantor/trantor
You can run trantor in /srv/www/trantor i.e. For this:
# mkdir -p /srv/www/trantor
# cd /srv/www/trantor
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/templates/ templates
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/css/ css
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/js/ js
# ln -s $GOPATH/src/pkg/gitlab.com/trantor/trantor/img/ img
Now you can run it:
# $GOPATH/bin/trantor
Go to your browser to: http://localhost:8080
=== For developers ===
Edit config.go if you want to change the port and other configuration, by default is 8080
Now you can compile Trantor:
$ go build
Now you can run it:
$ ./trantor
Go to your browser to: http://localhost:8080
== Bugs ==
Please, report bugs in the gitlab issue tracker:
https://gitlab.com/trantor/trantor/issues
== Rights ==
All the matterial of this project is under WTFPL as described on the LICENSE
file with the exception of:
- css/bootstrap.min.css css/bootstra-responsive.min.css js/bootstrap.min.js
img/glyphicons-halflings-white.png img/glyphicons-halflings.png
From the bootstrap framework: http://twitter.github.com/bootstrap/
- js/jquery.js
From jquery library: http://jquery.com/
- img/bright_squares.png
From subtlepatterns: http://subtlepatterns.com/bright-squares/
- css/FredokaOne.ttf css/PTSerif.ttf
From Google Web Fonts: http://www.google.com/webfonts
- js/bootstrap-tokenfield.min.js dist/css/bootstrap-tokenfield.min.css
From Bootstrap Tokenfield: https://github.com/sliptree/bootstrap-tokenfield

79
README.md Normal file
View file

@ -0,0 +1,79 @@
# Imperial Library of Trantor
The Imperial Library of Trantor (also known as Galactic Library) is a
repository management system of ebooks on ePub format.
You can check out the main development branch from GitLab at:
https://gitlab.com/trantor/
## Dependences
In order to run Trantor, you need to install the following packages:
* Go language
* postgresql (>= 9.6)
Yo also need to install go dependences:
# go get .
## Installation
### Create postgres DB
We can create the DB (using the postgres user) and activate `pg_trgm` extension
for it:
```
$ createdb trantor
$ echo "CREATE EXTENSION pg_trgm;"|psql trantor
```
### For admins ("for developers" below)
Now you can install Trantor itself:
```
# go get gitlab.com/trantor/trantor
```
You can run it (using `/var/lib/trantor` for storage):
```
# $GOPATH/bin/trantor -assets $GOPATH/src/pkg/gitlab.com/trantor/trantor/ -store /var/lib/trantor
```
Go to your browser to: http://localhost:8080
### For developers
Now you can compile Trantor:
```
$ go build
```
Now you can run it:
```
$ ./trantor
```
Go to your browser to: http://localhost:8080
## Bugs
Please, report bugs in the gitlab issue tracker:
https://gitlab.com/trantor/trantor/issues
## Rights
All the matterial of this project is under WTFPL as described on the LICENSE
file with the exception of:
* css/bootstrap.min.css css/bootstra-responsive.min.css js/bootstrap.min.js
img/glyphicons-halflings-white.png img/glyphicons-halflings.png
From the bootstrap framework: http://twitter.github.com/bootstrap/
* js/jquery.js
From jquery library: http://jquery.com/
* img/bright_squares.png
From subtlepatterns: http://subtlepatterns.com/bright-squares/
* css/FredokaOne.ttf css/PTSerif.ttf
From Google Web Fonts: http://www.google.com/webfonts
* js/bootstrap-tokenfield.min.js dist/css/bootstrap-tokenfield.min.css
From Bootstrap Tokenfield: https://github.com/sliptree/bootstrap-tokenfield