Find a file
Peter Camilleri def2b2a66b UG polishing
2015-07-25 14:43:39 -04:00
docs UG polishing 2015-07-25 14:43:39 -04:00
integration UG update; Seconds now format as a float. 2015-07-24 15:06:12 -04:00
lib Corrected the text of error msg for .to_duration! 2015-07-25 10:39:42 -04:00
tests Rationalized the conversion to Rational. 2015-07-15 14:07:14 -04:00
.gitignore UG update; Exceptions 2015-04-14 11:53:52 -04:00
.rdoc_options The Token struct and rdoc corrections. 2014-09-19 13:19:33 -04:00
demo.rb Minor demo update. 2015-01-14 21:50:07 -05:00
fOOrth.gemspec Updated to format_engine V0.2.0 2015-07-17 12:12:18 -04:00
fOOrth.reek Day 1 2014-09-09 15:35:22 -04:00
Gemfile Cleanup build env more like bundler would do it. 2014-11-03 16:51:04 -05:00
license.txt Day 1 2014-09-09 15:35:22 -04:00
rakefile.rb Corrected issue with integration tests in rakefile. 2015-04-12 18:08:47 -04:00
README.md Updated contributing guidelines. 2015-05-31 16:12:30 -04:00
reek.txt Upgraded to reek 3.04. Backed off making Duration act like a numeric. Now 2015-07-15 15:59:32 -04:00
sire.rb Fixed sire.rb so it can be run outside of rake. 2015-02-15 20:10:37 -05:00
t.txt SIRE enhancements. 2014-10-15 12:27:05 -04:00
test.foorth Added the )vm method for debug. 2015-01-29 13:59:39 -05:00

The fOOrth Language gem.

This file contains the read-me for the fOOrth language gem. The fOOrth language is an experimental variant of FORTH that attempts to incorporate object oriented and functional programming concepts.

As an aside, there can be no doubt that the fOOrth project is an utter waste of anyone's time, unless one counts the insights gained into the inner workings of Ruby and meta programming.

Usage

Adding fOOrth can be as simple as:

require 'fOOrth'
XfOOrth.main

This will launch an interactive fOOrth session. Alternatively this can be done with:

rake run

Be sure to be in the folder that contains the rakefile in order for this command to work.


If, instead, a non-interactive facility is required, use:

require 'fOOrth'
XfOOrth.virtual_machine.process_string '1 2 +'

where the string is fOOrth code to be executed, or for a file of code, use:

require 'fOOrth'
XfOOrth.virtual_machine.process_file 'my_file.foorth'

Further Documentation

The fOOrth Language System is documented in The fOOrth User Guide. This is currently only available in Open Office format, and is still also very much a work in progress. Please see The_fOOrth_User_Guide.odt in the docs folder.

As each version of fOOrth is made available, expect to see portable document format versions of the guide for each released version.

Contributing

  1. Fork it
  2. Switch to the development branch ('git branch development')
  3. Create your feature branch ('git checkout -b my-new-feature')
  4. Commit your changes ('git commit -am "Add some feature"')
  5. Push to the branch ('git push origin my-new-feature')
  6. Create new Pull Request

It is strongly encouraged to apply all new coding efforts to the development branch and not master.

For more details on the branching strategy, please see: http://nvie.com/posts/a-successful-git-branching-model/