Skip to content

Commit 08bc21d

Browse files
committed
Add readme file
1 parent ec89ed4 commit 08bc21d

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Python-Markdown Dingus
2+
3+
A simple site for testing Python-Markdown as well as the backend called by [Babelmark].
4+
Visit <http://waylan.pythonanywhere.com/dingus> for a live demo.
5+
6+
[Babelmark]: http://johnmacfarlane.net/babelmark2/
7+
8+
# Setup
9+
10+
To set up a dev environment, clone this repo and create a virtual environment. Then
11+
install the dependencies.
12+
13+
```bash
14+
python -m venv venv
15+
. venv/bin/activate
16+
pip install -r requirements.txt
17+
```
18+
19+
After a new release of Python-Markdown has been made, update with:
20+
21+
```bash
22+
pip install -U markdown
23+
```
24+
25+
# Running the server
26+
27+
To run a local instance of the server for development and testing:
28+
29+
```bash
30+
python dingus.py
31+
```
32+
33+
Then point your browser at <http://localhost:8080/dingus>.
34+
35+
# Copyright and License
36+
37+
[Markdown] and [Dingus] Copyright &copy; 2004 [John Gruber]<br />
38+
Additions and Modifications to Dingus (extension support, etc.) Copyright &copy; 2012-2020 [Waylan Limberg]
39+
40+
[Markdown]: http://daringfireball.net/projects/markdown/
41+
[Dingus]: http://daringfireball.net/projects/markdown/dingus
42+
[John Gruber]: http://daringfireball.net/colophon/
43+
[Waylan Limberg]: https://github.com/waylan

0 commit comments

Comments
 (0)