Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added notes about mysql dependency to README

  • Loading branch information...
commit 93d64f4d89fb3c2ba16956981cbefe6d28dd2d46 1 parent b6ec3da
Sigve Sebastian Farstad sigvef authored
Showing with 10 additions and 4 deletions.
  1. +10 −4 README.md
14 README.md
View
@@ -28,12 +28,13 @@ You will need
- requests
- alembic
- flask-principal
+ - mysql/mysql\_config
- mysql-python
-as well as their respective dependencies. All of these are available on PyPI and as such
-I recommend using a virtualenv and pip to install all of those. Always get the newest version
-of any of these. If flamejam should be incompatible with the latest version of one of these
-packages, it is to be considered a bug and should be fixed.
+as well as their respective dependencies. All of these except mysql/mysql\_config are available
+on PyPI and as such I recommend using a virtualenv and pip to install all of those. Always get
+the newest version of any of these. If flamejam should be incompatible with the latest version of
+one of these packages, it is to be considered a bug and should be fixed.
Installation
------------
@@ -70,9 +71,14 @@ Development
For development and testing, firstly set up a virtualenv containing all dependencies. For your
convenience, a Makefile target has been provided. Run `make setup` to have it set up for you.
+You also need a mysql installation with mysql-config available. On Ubuntu the package is called
+`libmysqlclient-dev`. Run `make init-db <username> <password> <email>` and `make seed-db` to
+setup a development database.
+
When this is done, run `python runserver.py` inside the virtualenv to fire up the
debug server and navigate to http://localhost:5000. Alternatively you can use `make run`.
+
Support and contact
-------------------
In order to receive help in getting this application to run, it would be best to ask
Please sign in to comment.
Something went wrong with that request. Please try again.