commit 20d165ac174f2ada0b0e8cb8f0c5bdb0e7d0acfe Author: Miguel Grinberg Date: Sun Dec 16 00:17:46 2012 -0800 initial commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a33e35 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +microblog +========= + +A decently featured microblogging web application written in Python and Flask that I'm developing in my Flask Mega-Tutorial series that begins [here](http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world). + +Installation +------------ + +The tutorial referenced above explains how to setup a virtual environment with all the required modules. As a convenience, the `setup.py` script will create this virtual environment for you. You can run this script again to refresh any missing modules. + +The sqlite database must also be created before the application can run, and the `db_create.py` script takes care of that. See the [Database tutorial](http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-iv-database) for the details. + +Running +------- + +To run the application in the development web server just execute `run.py` with the Python interpreter from the flask virtual environment. +