Browse files

Renamed README to README.rst and added few doc diagrams.

  • Loading branch information...
1 parent 3b4cc99 commit dfb99b8c99d016006c723ca6ce9fe175f973018a @BasicWolf committed Sep 27, 2012
View
24 README
@@ -1,24 +0,0 @@
-Kaylee
-======
-
-Kaylee is distributed and volunteer in-browser computing framework.
-It is written in Python and CoffeeScript.
-
-
-Is it ready yet?
-================
-
-Yes, as long as you stick to the provided API. Kaylee is currently
-in early development, but we're looking forward to stick with the
-API, especially the *Projects* part of it.
-
-
-Where are the docs?
-===================
-
-Right here, in ``/doc``, or at http://kaylee.znasibov.info/docs
-
-I need help!
-============
-
-Feel free to report an issue on github: https://github.com/BasicWolf/Kaylee
View
1 README
View
24 README.rst
@@ -0,0 +1,24 @@
+Kaylee
+======
+
+Kaylee is distributed and volunteer in-browser computing framework.
+It is written in Python and CoffeeScript.
+
+
+Is it ready yet?
+================
+
+Yes, as long as you stick to the provided API. Kaylee is currently
+in early development, but we're looking forward to stick with the
+API, especially the *Projects* part of it.
+
+
+Where are the docs?
+===================
+
+Right here, in ``/doc``, or at http://kaylee.znasibov.info/docs
+
+I need help!
+============
+
+Feel free to report an issue on github: https://github.com/BasicWolf/Kaylee
View
BIN doc/_static/kaylee.dia
Binary file not shown.
View
BIN doc/_static/kaylee.dia.autosave
Binary file not shown.
View
BIN doc/_static/kaylee.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN doc/_static/kaylee_dia_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN doc/_static/kaylee_dia_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
22 doc/_templates/sidebarintro.html
@@ -0,0 +1,22 @@
+<h3>About Kaylee</h3>
+<p>
+ Kaylee is a distributed and volunteer computing framework for Python.
+ You are currently looking at the documentation of the development version.
+ Things are not stable yet, but if you have some feedback,
+ <a href="mailto:kaylee@kaylee.znasibov.info">let me know</a>.
+</p>
+<h3>Other Formats</h3>
+<p>
+ You can download the documentation in other formats as well:
+</p>
+<ul>
+ <!-- <li><a href="http://kaylee.znasibov.info/docs/kaylee-docs.pdf">as PDF</a> -->
+ <li><a href="http://kaylee.znasibov.info/docs/kaylee-docs.zip">as zipped HTML</a>
+</ul>
+<h3>Useful Links</h3>
+<ul>
+ <li><a href="http://kaylee.znasibiv.info/">Kaylee Website</a></li>
+ <li><a href="http://pypi.python.org/pypi/Kaylee">Kaylee @ PyPI</a></li>
+ <li><a href="http://github.com/basicwolf/kaylee">Kaylee @ github</a></li>
+ <li><a href="http://github.com/basicwolf/kaylee/issues">Issue Tracker</a></li>
+</ul>

0 comments on commit dfb99b8

Please sign in to comment.