diff --git a/README.md b/README.md index bb7621a..802020e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ # Menu Helper +A program to manage a database of recipes and help you to pick out meals based +on filters of ingredients and tags. + ## Usage +Ensure the `XDG_DATA_HOME` variable is set (e.g. to `$HOME/.local/share`). + ## Building +To build the program you will require the following dependencies: + +- A C compiler compatible with GNU99 C (preferably GCC). +- SQLite3 C library +- Make + +Once installed, compile the project with the `make` command. + ## License + +This program is licensed under the terms & conditions of the GNU General Public +License version 3 or greater. See the [LICENSE](/LICENSE) file for more +information.