Permalink
Browse files

Updated readme for dev instructions.

  • Loading branch information...
1 parent 1244382 commit c802400d8b54cb24d00a99d5b1bc3c9308ba4526 @geojeff committed Feb 11, 2013
Showing with 51 additions and 10 deletions.
  1. +22 −3 README.rst
  2. +29 −7 docs/sources/index.rst
View
@@ -27,12 +27,31 @@ base system prerequisites for Kivy:
NOTE: Until kivy_statecharts is on PyPI, do clone and setup as below:
-If you are debugging or adding features to kivy_statecharts, clone the repo
-and set up for development:
+If you are debugging or adding features to kivy_statecharts, here is one way
+to work with it. Make a virtualenv for doing kivy-statechart work. Here are
+steps using the virtualenvwrapper system::
+
+ mkvirtualenv kivy_statecharts
+
+ cdvirtualenv
+
+You can check the paths for python, pip and other things in bin, and perhaps
+issue this command to ensure you are working properly in the virtualenv::
+
+ workon kivy_statecharts
+
+Do steps to install kivy; if using master, install dependencies, then git clone
+it, and inside kivy, do::
+
+ python setup.py develop
+
+Clone the kivy-statecharts repo::
git clone https://github.com/geojeff/kivy-statecharts.git
+
python setup develop
- python setup dev (See below; For setting up for testing)
+
+ python setup dev (for setting up for testing)
Be warned: This addon is in alpha state. Use it at your own risk.
View
@@ -47,13 +47,35 @@ As of April 2012, most tests were ported.
Introduction
============
-The kivy-statecharts framework might be called "advanced," but this is a
-mistaken notion. As we will see in the examples, even a simple application can
-be made using statecharts. However, because there is a natural progression and
-dedicated documentation for learning basic Kivy programming, it is assumed here
-that you already understand Kivy bindings and the events system, how to build
-widgets with both python and kv language approaches, and general concepts of
-using Kivy.
+The kivy-statecharts framework might be called "advanced," because it is an
+add-on to basic widget, kv, and idiomatic Kivy programming style. However, as
+we will see in the examples, even a simple application can be made using
+statecharts. However, because there is a natural progression and dedicated
+documentation for learning basic Kivy programming, it is assumed here that you
+already understand Kivy bindings and the events system, how to build widgets
+with both python and kv language approaches, and general concepts of using
+Kivy.
+
+Why Use Statecharts?
+--------------------
+
+Michael Cohen provided a good summary: https://github.com/FrozenCanuck/Ki.
+
+If you are just starting to develop an app, consider using statecharts, even
+though you may not see the advantage when your app is small.
+
+If you aren't using statecharts, and you find yourself mired in complexity,
+adapting your app to use statecharts should help.
+
+Programming with statecharts can provide a comfort level, even for structuring
+code for a basic application, and the facilities are there for realizing
+solutions to handle complex situations such as those requiring concurrent
+processing, intricate start-and-stop action for subprocesses, and so on. There
+is a learning curve for these facilities, but it is probably worth the
+investment.
+
+Making a Statechart
+-------------------
The developer may code the statechart for a new app directly, or a statechart
drawing may be done first. At some point, making a statechart drawing is

0 comments on commit c802400

Please sign in to comment.