diff options
| author | murphy <murphy@rubychan.de> | 2006-04-15 14:02:02 +0000 |
|---|---|---|
| committer | murphy <murphy@rubychan.de> | 2006-04-15 14:02:02 +0000 |
| commit | 915a4ade8840f076b2ad2681944ab845ef038f0c (patch) | |
| tree | a4f3445c19dc42ad8979f0e0d11ef4a49f4135ae /FOLDERS | |
| parent | 867ee75e4ede929cf0e7d9e5c2aa4e7fad49e28b (diff) | |
| download | coderay-915a4ade8840f076b2ad2681944ab845ef038f0c.tar.gz | |
FOLDERS documentation added.
Rakefile updated.
Diffstat (limited to 'FOLDERS')
| -rw-r--r-- | FOLDERS | 53 |
1 files changed, 53 insertions, 0 deletions
@@ -0,0 +1,53 @@ += CodeRay - Trunk folder structure
+
+== bench - Benchmarking system
+
+All benchmarking stuff goes here.
+
+Test inputs are stored in files named <code>example.<lang></code>.
+Test outputs go to <code>bench/test.<encoder-default-file-extension></code>.
+
+Run <code>bench/bench.rb</code> to get a usage description.
+
+Run <code>rake bench</code> to perform an example benchmark.
+
+
+== bin - Scripts
+
+Executional files for CodeRay.
+
+
+== demo - Demos and functional tests
+
+Demonstrational scripts to show of CodeRay's features.
+
+Run them as functional tests with <code>rake test:demos</code>.
+
+
+== etc - Lots of stuff
+
+Some addidtional files for CodeRay, mainly graphics and Vim scripts.
+
+
+== gem_server - Gem output folder
+
+For <code>rake gem</code>.
+
+
+== lib - CodeRay library code
+
+This is the base directory for the CodeRay library.
+
+
+== rake_helpers - Rake helper libraries
+
+Some files to enhance Rake, including the Autumnal Rdoc template and some scripts.
+
+
+== test - Tests
+
+Test for the scanners.
+
+Each language has its own subfolder and sub-suite.
+
+Run with <code>rake test</code>.
|