Skip to content

Commit

Permalink
Tweak README
Browse files Browse the repository at this point in the history
  • Loading branch information
nguermond committed Mar 14, 2022
1 parent 838bff2 commit 08ec134
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,24 @@ A GUI for managing document metadata for books, textbooks, or articles.
* error permissive search

## Configuration
Library configuration is stored in `$HOME/.doculib/libraries.json`.
Metadata is stored in `$HOME/.doculib/data`.
Metadata for DocuLib is tored in `$HOME/.doculib/`.

## Dependencies
## How to build from source:
1. Install [opam](https://opam.ocaml.org/)
2. Install OCaml >= 4.12.0:
```
sudo apt install libev-dev libgtk-3-0
opam switch create 4.12.0 && eval $(opam env)
```

Note this requires lablgtk3 (>= 3.1.2)
```
opam install dune lablgtk3 lwt irmin-unix tls
2. Install system dependencies:
```

## Compile
sudo apt install libgmp-dev pkg-config libcairo2-dev libexpat1-dev libgtk-3-dev
```
dune build
```

## Run
3. Install Ocaml dependencies:
```
dune exec ./doculib.exe
opam install dune cohttp-lwt-unix yojson lablgtk3.3.1.2
```
4. Compile with `dune build`
5. Run with `dune exec ./doculib.exe`

## To be (maybe) implemented
* fancy tag management (synonyms, subtags...)
Expand Down

0 comments on commit 08ec134

Please sign in to comment.