Skip to content

Commit c5c1d22

Browse files
committed
Merge pull request #3 from pydy/add-readme
Added a basic README with build instructions.
2 parents 7b82f80 + e3e499c commit c5c1d22

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
This repository contains the source files for the website hosted through Github
2+
Pages at http://github.com/pydy/pydy.github.io.
3+
4+
Dependencies
5+
============
6+
7+
- Sphinx http://sphinx-doc.org/
8+
- Sphinx Bootstrap Theme https://github.com/ryan-roemer/sphinx-bootstrap-theme
9+
- werkzeug http://werkzeug.pocoo.org/
10+
- ablog http://ablog.readthedocs.org
11+
12+
Build Process
13+
=============
14+
15+
Build the website with the included ``Makefile``::
16+
17+
make html
18+
19+
Serve the website locally with, e.g.::
20+
21+
firefox _build/html/index.html
22+
23+
Once the website is to your liking, copy the files from ``_build/html`` to the
24+
root directory of your clone of the https://github.com/pydy/pydy.github.io
25+
repository and submit a pull request with the updates. Make sure you do not
26+
delete the `.nojekyll` file in that repository.

0 commit comments

Comments
 (0)