Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions README

This file was deleted.

29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Flask-Markdown

This is a small module to load markdown processing into
your flask.

## To setup the development environment

```bash
$ git clone https://github.com/dcolish/flask-markdown.git
$ virtualenv ENV
$ . ENV/bin/activate
$ python setup.py develop
```

## Run the test site

```bash
$ python setup.py test
```

#### !! There is a bug in the current release of 'nose' which results in 'NoneType' objects being called on test-suite shutdown. Please ignore this.

## To setup the documentation environment

```bash
$ pip install sphinx
$ git submodule init
$ git submodule update
```