Skip to content

Commit

Permalink
tweaking the README for better inclusion
Browse files Browse the repository at this point in the history
  • Loading branch information
esc committed Jan 26, 2013
1 parent 2e2836d commit 30275ae
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
===================
Scipy-Lecture-Notes
===================

This repository gathers some lecture notes on the scientific Python
ecosystem that can be used for a full course of scientific computing with
Python.

These documents are written with the rest markup language (.rst
These documents are written with the rest markup language (``.rst``
extension) and built using Sphinx: http://sphinx.pocoo.org/.

Modifying
==========

Reusing and distributing
-------------------------

As stated in the LICENSE.txt file, this material comes with no strings
As stated in the ``LICENSE.txt`` file, this material comes with no strings
attached. Feel free to reuse and modify for your own teaching purposes.

However, we would like this reference material to be improved over time,
thus we encourage people to contribute back changes. These will be
reviewed and edited by the original authors.
reviewed and edited by the original authors and the editors.

Building instructions
----------------------
Expand All @@ -35,7 +36,7 @@ To generate the pdf file for printing::
make pdf

The pdf builder is a bit pointy and you might have some TeX errors. Tweaking
the layout in the rst files is usually enough to work around these
the layout in the ``*.rst`` files is usually enough to work around these
problems.

Requirements
Expand All @@ -55,7 +56,7 @@ Contributing

.. topic:: Contributing guide and chapter example

The directory `guide` contains an example chapter with specific
The directory ``guide`` contains an example chapter with specific
instructions on how to contribute:

.. toctree::
Expand Down

0 comments on commit 30275ae

Please sign in to comment.