better readme

This commit is contained in:
Bachir Soussi Chiadmi
2017-06-08 23:15:33 +02:00
parent 7baaf0e221
commit 2c82ffd7c9
+63 -3
View File
@@ -4,13 +4,73 @@
A Markup Cascading Styles Printing software.
## Design Stack
Inspired by [html2print](http://osp.kitchen/tools/html2print/) from [osp](osp.kitchen), you can write and organize your contents with markdown, design your layout with css and js, export to pdf and share your work with git.
## Contents
![Contents Stack](libriis/assets/images/Screenshot_stackcontents.png)
## Design
![Design Stack](libriis/assets/images/Screenshot_stackdesign.png)
## Contents Stack
![Contents Stack](libriis/assets/images/Screenshot_stackcontents.png)
## Installation
Libriis is developed with python and pyqt5, if you are confident with theese tools you should be able to build the app.
!! following install code is not yet functional !!
```shell
pip install sass
pip install pyphen
git clone https://figureslibres.io/gogs/bachir/libriis.git
cd libriis
python setup.py install --optimize=1 -f
```
### Arch
For Arch Linux and derivated distro, an aur package exists :
```
yaourt -S libriis-git
```
### qt-webkit
for now, pdf export needs a custom build of qtwebkit, see [ospkit](http://osp.kitchen/tools/ospkit/)
```shell
sudo apt-get install build-essential perl python ruby flex gperf bison \
cmake ninja-build libfontconfig1-dev libicu-dev libsqlite3-dev \
zlib1g-dev libpng12-dev libjpeg-dev libxslt1-dev libxml2-dev libhyphen-dev
git clone -b ospkit --single-branch https://github.com/aleray/webkit.git
cd webkit
WEBKIT_OUTPUTDIR=`pwd`/build/qt
Tools/Scripts/build-webkit --qt --release --no-web-audio --no-video
cd build/qt/Release
sudo ninja install
```
## Roadmap
[] add git features
[] handle pictures
[] embed custom build of qtwebkit specialized in print (eg remove video)
## Mockups