README in openwferu-0.9.0 vs README in openwferu-0.9.1
- old
+ new
@@ -5,12 +5,15 @@
== Supported platforms
TODO
== Installation
-TODO
+Installation can be handled by Ruby gems. This will pull in any libraries
+you will need to install
+ gem install -y openwferu
+
== Overview
OpenWFEru is a Ruby port of the OpenWFE workflow engine
(http://www.openwfe.org). It is a complete rewrite in Ruby
so does not need to use the Java-based engine from OpenWFE.
@@ -27,14 +30,59 @@
These are mostly stolen from the unit tests
Creating an workflow engine instance
+ require 'pp'
require 'openwferu'
- engine = OpenWFEru::Engine.new()
+ # Create an engine to launch the flow
+ engine = OpenWFEru::Engine.new
engine.register_participant('test-.*',
OpenWFEru::PrintParticipant.new())
+ # Create a flow definition and assign to a new instance
+ flow = '''<process-definition name="equals_0" revision="0">
+ <sequence>
+ <equals value="a" other-value="a" />
+ <print>${field:__result__}</print>
+ </sequence>
+ </process-definition>'''
+ li = OpenWFE::LaunchItem.new
+ li.workflowDefinitionUrl = "field:__definition"
+ li.attributes['__definition'] = flow
+ # Launch the instance
+ engine.launch(li)
+ # Examine it
+ exp_storage = engine.application_context[OpenWFEru::S_EXPRESSION_STORAGE]
+ pp exp_storage
+
+== How to help
+
+If you want to help hacking on openwferu you'll probably want the following
+libraries:
+[+rake+] Handle builds, generating documentation, and running unit tests
+[rubygems] Handles creation of the gems
+[rote] A framework being used to help with managing the offline written docs
+[redcloth] Openwferu uses textile-markup for its docs. Redcloth provides an engine for it.
+[tidy] General cleanup
+[libxml-ruby] Allows XSD validation
+
+It's best if you use gems to install these as the process can get rather
+tedious by hand.
+
+=== Prerequisites
+You'll need libxml2-dev in order to compile the native libraries
+for libxml. Please check your your packaging system for the appropriate
+name.
+
+On Ubuntu you can install libxml2 with:
+ sudo apt-get install libxml2-dev
+
+=== Ruby Libraries Install
+1. gem install -r rake
+2. gem install -r rote redcloth
+3. gem install -r tidy
+4. gem install -r libxml-ruby
== Documentation
The main project site lives at rubyforge at:
http://rubyforge.org/projects/openwferu