Commits

James Mills committed c2c3408

docs: Cleaned up

Comments (0)

Files changed (3)

docs/Contributing.wiki

 ''No known issues''
 
 == Coding style ==
-Since it's hard to argue with someone who's already written a code style 
+Since it's hard to argue with someone who's already written a code style
 document, Circuits follows
 [http://www.python.org/peps/pep-0008.html PEP 8] conventions with some minor
 exceptions:
 Automated unit tests are better than good. They make future growth of the
 project possible.
 
-Circuits uses [http://somethingaboutorange.com/mrl/projects/nose/ Nose] 
+Circuits uses [http://somethingaboutorange.com/mrl/projects/nose/ Nose]
 which makes testing easy. You can run the tests just by running
 {{{nosetests}}} or {{{make tests}}} in the top-level of the source tree.
 
 The Circuits Documentation is available at:
  * http://trac.softcircuit.com.au/circuits/wiki/docs
 
-Please document your own work. It doesn't have to be Shakespeare, but 
+Please document your own work. It doesn't have to be Shakespeare, but
 the editors don't enjoy writing documentation any more than you do
 (''we'd rather be coding'') and it's much easier to edit an existing
 document than it is to figure out your code and write something from scratch.
 The [http://trac.softcircuit.com.au/circuits/ Circuits Trac] is mostly
 used for tracking upcoming changes and tasks required before release
 of a new version.
-The [http://trac.softcircuit.com.au/circuits/wiki/docs/ChangeLog ChangeLog] 
+The [http://trac.softcircuit.com.au/circuits/wiki/docs/ChangeLog ChangeLog]
 provides the human readable list of changes.
 
 Updating the [wiki:docs/ChangeLog ChangeLog] right before a release just slows

docs/DownloadInstall.wiki

  * Python 2.5 or greater (''Also works with Python 3.x``)
 
 === Setting up setuptools: ===
-On Windows: 
- download http://peak.telecommunity.com/dist/ez_setup.py and then run it from 
+On Windows:
+ download http://peak.telecommunity.com/dist/ez_setup.py and then run it from
  the command line.
 
-On UNIX: 
- If you have curl or  wget installed you can do this with a single command: 
+On UNIX:
+ If you have curl or  wget installed you can do this with a single command:
 
 {{{
 #!/sh
 
 {{{
 ~/circuits/examples
-$ python hello.py 
+$ python hello.py
 Hello World
 }}}
 ----

docs/FrequentlyAskedQuestions.wiki

-= circuits FAQ =
-[[TOC]]
-
-== General ==
-
-=== How do you use circuits? ===
- * Have you read the website ?
- * Have you looked at the various examples ?
-
-See: http://trac.softcircuit.com.au/circuits/
-
-=== What is circuits ? ===
- * circuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier
- * circuits allows you to write maintainable and scalable systems easily
-
-=== Would you consider writing networking based programs using circuits versus [http://twistedmatrix.org Twisted matrix ] ? ===
- * YES absolutely. I always have.
-
-Twisted (''to be perfectly honest'') is:
- * Complicated
- * Hard to understand
- * Not light weight
-
-circuits is:
- * Simple
- * Consistent
- * Robust
- * Easy to understand
- * Very light weight.
-
-=== GUI programming: Would circuits integrate with some GUI frameworks ? ===
- * This is definitely possible.
- * Currently I have no adapters for any GUI frameworks. but please feel free to write and submit a Component :)
-
-=== What are the concepts behind circuits ? ===
- a) Everything is a Component
- b) Components communicate by propagating Events
-
-Also:
- * Components can be interlinked
- * Components are capable of managing their own Events and the Events of other Components.
-
-=== How would you compare circuits to Twisted ? ===
- * circuits is simpler
- * circuits is maintainable
- * circuits has a nicer cleaner architecture: See [source:docs/graphs/ Dependency Graphs]
- * circuits is Component based.
- * circuits is purely 100% Event and asynchronous.
-
-=== Can Components reside in different processes and talk to each others ? ===
- * YES
- * Currently in the works:
-  * Process Component using the Python multiprocessing library.
-
-=== Is there any restriction on the OS that circuits can run on ? ===
- * No. Although:
-  * I only test on Linux and Mac OS X (''I don't have Windows to test on'').
- * Testers Welcome!
-
-=== What version of Python does circuits work with ? ===
- * Currently circuits is tested with:
-  * Python 2.5
-
-=== Since circuits is an event-driven framework, how are you handling unit/integration tests ? ===
-
-> I'm lead to understand that unit-testing with event-driven software is often difficult if actually possible.
-
-> Are you using something akin to [http://twistedmatrix.com/trac/wiki/TwistedTrial TwistedTrial] ?
-
-> Are you running unit-tests across distributed test environments ?
-
- * circuits is not only a very good event-driven framework, but also a great Component framework.
- * Have a look at the [source:circuits/tests/ unit tests] that test the core of circuits.
-
-=== Can circuits be used for concurrent or distributed programming ? ===
-
-YES absolutely. See the [source:examples/primes.py Distributed Prime number finder]
-
-----
-Got a question ?
- * Send an email to: circuits at shortcircuit dot net dot au
- * Post your question on this page.
- * Visit irc;//irc.freenode.net#circuits
+= circuits FAQ =
+[[TOC]]
+
+== General ==
+
+=== How do you use circuits? ===
+ * Have you read the website ?
+ * Have you looked at the various examples ?
+
+See: http://trac.softcircuit.com.au/circuits/
+
+=== What is circuits ? ===
+ * circuits is an event-driven framework with a high focus on Component architectures making your life as a software developer much easier
+ * circuits allows you to write maintainable and scalable systems easily
+
+=== Would you consider writing networking based programs using circuits versus [http://twistedmatrix.org Twisted matrix ] ? ===
+ * YES absolutely. I always have.
+
+Twisted (''to be perfectly honest'') is:
+ * Complicated
+ * Hard to understand
+ * Not light weight
+
+circuits is:
+ * Simple
+ * Consistent
+ * Robust
+ * Easy to understand
+ * Very light weight.
+
+=== GUI programming: Would circuits integrate with some GUI frameworks ? ===
+ * This is definitely possible.
+ * Currently I have no adapters for any GUI frameworks. but please feel free to write and submit a Component :)
+
+=== What are the concepts behind circuits ? ===
+ a) Everything is a Component
+ b) Components communicate by propagating Events
+
+Also:
+ * Components can be interlinked
+ * Components are capable of managing their own Events and the Events of other Components.
+
+=== How would you compare circuits to Twisted ? ===
+ * circuits is simpler
+ * circuits is maintainable
+ * circuits has a nicer cleaner architecture: See [source:docs/graphs/ Dependency Graphs]
+ * circuits is Component based.
+ * circuits is purely 100% Event and asynchronous.
+
+=== Can Components reside in different processes and talk to each others ? ===
+ * YES
+ * Currently in the works:
+  * Process Component using the Python multiprocessing library.
+
+=== Is there any restriction on the OS that circuits can run on ? ===
+ * No. Although:
+  * I only test on Linux and Mac OS X (''I don't have Windows to test on'').
+ * Testers Welcome!
+
+=== What version of Python does circuits work with ? ===
+ * Currently circuits is tested with:
+  * Python 2.5
+
+=== Since circuits is an event-driven framework, how are you handling unit/integration tests ? ===
+
+> I'm lead to understand that unit-testing with event-driven software is often difficult if actually possible.
+
+> Are you using something akin to [http://twistedmatrix.com/trac/wiki/TwistedTrial TwistedTrial] ?
+
+> Are you running unit-tests across distributed test environments ?
+
+ * circuits is not only a very good event-driven framework, but also a great Component framework.
+ * Have a look at the [source:circuits/tests/ unit tests] that test the core of circuits.
+
+=== Can circuits be used for concurrent or distributed programming ? ===
+
+YES absolutely. See the [source:examples/primes.py Distributed Prime number finder]
+
+----
+Got a question ?
+ * Send an email to: circuits at shortcircuit dot net dot au
+ * Post your question on this page.
+ * Visit irc;//irc.freenode.net#circuits
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.