Commit 77c942f8 authored by Johannes Schwab's avatar Johannes Schwab

update README

parent 045669c4
OpenRecipes is a privacy friendly personal cook book.
Most notable feature is the possibility so synchronize your recipes between multiple devices.
The data is therby end-to-end encrypted between devices.
Other features are:
- Edit your recipes with images
- Calculate ingredients for different number of portions
- Save and import recipes to/from file
- On Android: share recipes via other apps
The client currently runs at Android, Linux and Windows.
The server only runs on Linux. It needs a mysql compatible database and is configured with an ini style file like this:
[general]
;number of jobs to run in the background (>=1) (optional, default: 2)
jobs=2
[server]
;port to listen for connections
port=44556
[mysql]
;mysql user name
user=your_username
;mysql password
password=your_password
;mysql database
database=yout_database
;host of the mysql server (optional, default: localhost)
host=hostname
;port the mysql server listens to (optional, default: 3306)
port=3306
You also need to apply the latest db schema from server/dbSchema to the database you intend to use.
While the server is running, he will print out some status information when receiving SIGUSR1.
To build from source you will need:
- Qt >= 5.11
- libsodium >= 1.0.12
- libqrencode
# OpenRecipes
OpenRecipes is a privacy friendly personal cook book.
Most notable feature is the possibility so synchronize your recipes between multiple devices.
The data is end-to-end encrypted between devices.
Other features are:
* Edit your recipes with images
* Calculate ingredients for different number of portions
* Save and import recipes to/from file
* On Android: share recipes via other apps
The client currently runs at Android, Linux and Windows.
The server only runs on Linux. It needs a mysql compatible database and is configured with an ini style file like this:
[general]
;number of jobs to run in the background (>=1) (optional, default: 2)
jobs=2
[server]
;port to listen for connections
port=44556
[mysql]
;mysql user name
user=your_username
;mysql password
password=your_password
;mysql database
database=yout_database
;host of the mysql server (optional, default: localhost)
host=hostname
;port the mysql server listens to (optional, default: 3306)
port=3306
You also need to apply the latest db schema from `server/dbSchema` to the database you intend to use.
While the server is running, he will print out some status information when receiving SIGUSR1 (for example with `killall -USR1 openrecipesserver`).
## Binary releases
For prebuild releases please refer to <https://openrecipes.jschwab.org>.
## Build from source
To build from source you will need:
* Qt >= 5.11
* libsodium >= 1.0.12
* libqrencode
You can build everything with
qmake
make
If you want to build only specific parts (for example if your are building on a sever that doesn't has the qt GUI parts installed), you can run `qmake` and `make` in the specific subdirectory.
You always need to build lib though.
E.g. to only build the server do something like
cd lib
qmake
make
cd ../server
qmake
make
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment