Skip to content

Loading…

Change readme file to use the reStructuredText format #643

Closed
wants to merge 1 commit into from

2 participants

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Showing with 70 additions and 55 deletions.
  1. +0 −55 README
  2. +70 −0 README.rst
View
55 README
@@ -1,55 +0,0 @@
- // Flask //
-
- web development, one drop at a time
-
-
- ~ What is Flask?
-
- Flask is a microframework for Python based on Werkzeug
- and Jinja2. It's intended for getting started very quickly
- and was developed with best intentions in mind.
-
- ~ Is it ready?
-
- It's still not 1.0 but it's shaping up nicely and is
- already widely used. Consider the API to slightly
- improve over time but we don't plan on breaking it.
-
- ~ What do I need?
-
- Jinja 2.4 and Werkzeug 0.7 or later.
- `pip` or `easy_install` will install them for you if you do
- `pip install Flask`. I encourage you to use a virtualenv.
- Check the docs for complete installation and usage
- instructions.
-
- ~ Where are the docs?
-
- Go to http://flask.pocoo.org/docs/ for a prebuilt version
- of the current documentation. Otherwise build them yourself
- from the sphinx sources in the docs folder.
-
- ~ Where are the tests?
-
- Good that you're asking. The tests are in the
- flask/testsuite package. To run the tests use the
- `run-tests.py` file:
-
- $ python run-tests.py
-
- If it's not enough output for you, you can use the
- `--verbose` flag:
-
- $ python run-tests.py --verbose
-
- If you just want one particular testcase to run you can
- provide it on the command line:
-
- $ python run-tests.py test_to_run
-
- ~ Where can I get help?
-
- Either use the #pocoo IRC channel on irc.freenode.net or
- ask on the mailinglist: http://flask.pocoo.org/mailinglist/
-
- See http://flask.pocoo.org/community/ for more resources.
View
70 README.rst
@@ -0,0 +1,70 @@
+Flask: web development, one drop at a time
+===========================================
+
+What is Flask?
+--------------
+
+Flask is a microframework for Python based on `Werkzeug`_
+and `Jinja2`_. It's intended for getting started very quickly
+and was developed with best intentions in mind.
+
+Is it ready?
+------------
+
+It's still not 1.0 but it's shaping up nicely and is
+already widely used. Consider the API to slightly
+improve over time but we don't plan on breaking it.
+
+What do I need?
+---------------
+
+Jinja 2.4 and Werkzeug 0.7 or later.
+``pip`` or ``easy_install`` will install them for you if you do
+``pip install Flask``. I encourage you to use a virtualenv.
+Check the docs for complete installation and usage
+instructions.
+
+Where are the docs?
+-------------------
+
+Go to http://flask.pocoo.org/docs/ for a prebuilt version
+of the current documentation. Otherwise build them yourself
+from the sphinx sources in the ``docs`` folder.
+
+Where are the tests?
+--------------------
+
+Good that you're asking. The tests are in the
+``flask/testsuite`` package. To run the tests use the
+``run-tests.py`` file:
+
+.. code-block:: bash
+
+ $ python run-tests.py
+
+If it's not enough output for you, you can use the
+``--verbose`` flag:
+
+.. code-block:: bash
+
+ $ python run-tests.py --verbose
+
+If you just want one particular testcase to run you can
+provide it on the command line:
+
+.. code-block:: bash
+
+ $ python run-tests.py test_to_run
+
+Where can I get help?
+---------------------
+
+Either use the #pocoo IRC channel on irc.freenode.net or
+ask on the `mailinglist`_.
+
+See `community page`_ for more resources.
+
+.. _Werkzeug: http://werkzeug.pocoo.org/
+.. _Jinja2: http://jinja.pocoo.org/
+.. _mailinglist: http://flask.pocoo.org/mailinglist/
+.. _community page: http://flask.pocoo.org/community/
Something went wrong with that request. Please try again.