diff options
author | Kornelius Kalnbach <murphy@rubychan.de> | 2016-06-04 13:59:09 +0200 |
---|---|---|
committer | Kornelius Kalnbach <murphy@rubychan.de> | 2016-06-04 13:59:09 +0200 |
commit | 3e10d565f99025bdca003cc8fbd98d3260ae451a (patch) | |
tree | 85cd39a0101139a193b4d98ba8d0129a83884302 /FOLDERS | |
parent | 0b19ccfa96e1c7e4999e6e2619ae0b266b54402a (diff) | |
parent | 4c7bedc3bf2392444f62e90b7b8dc91d1a2effbb (diff) | |
download | coderay-3e10d565f99025bdca003cc8fbd98d3260ae451a.tar.gz |
Merge branch 'master' into possible-speedups
Diffstat (limited to 'FOLDERS')
-rw-r--r-- | FOLDERS | 96 |
1 files changed, 48 insertions, 48 deletions
@@ -1,48 +1,48 @@ -= CodeRay - 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.
-
-coderay:: The CodeRay executable.
-
-== 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.
-
-
-== 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
-
-In the subfolder scanners/ are the scanners tests.
-Each language has its own subfolder and sub-suite.
-
-Run with <code>rake test</code>.
+= CodeRay - 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. + +coderay:: The CodeRay executable. + +== 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 additional files for CodeRay, mainly graphics and Vim scripts. + + +== 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 + +In the subfolder scanners/ are the scanners tests. +Each language has its own subfolder and sub-suite. + +Run with <code>rake test</code>. |