|
1 | | -= CodeRay - folder structure |
2 | | -
|
3 | | -== bench - Benchmarking system |
4 | | -
|
5 | | -All benchmarking stuff goes here. |
6 | | -
|
7 | | -Test inputs are stored in files named <code>example.<lang></code>. |
8 | | -Test outputs go to <code>bench/test.<encoder-default-file-extension></code>. |
9 | | -
|
10 | | -Run <code>bench/bench.rb</code> to get a usage description. |
11 | | -
|
12 | | -Run <code>rake bench</code> to perform an example benchmark. |
13 | | -
|
14 | | -
|
15 | | -== bin - Scripts |
16 | | -
|
17 | | -Executional files for CodeRay. |
18 | | -
|
19 | | -coderay:: The CodeRay executable. |
20 | | -
|
21 | | -== demo - Demos and functional tests |
22 | | -
|
23 | | -Demonstrational scripts to show of CodeRay's features. |
24 | | -
|
25 | | -Run them as functional tests with <code>rake test:demos</code>. |
26 | | -
|
27 | | -
|
28 | | -== etc - Lots of stuff |
29 | | -
|
30 | | -Some addidtional files for CodeRay, mainly graphics and Vim scripts. |
31 | | -
|
32 | | -
|
33 | | -== lib - CodeRay library code |
34 | | -
|
35 | | -This is the base directory for the CodeRay library. |
36 | | -
|
37 | | -
|
38 | | -== rake_helpers - Rake helper libraries |
39 | | -
|
40 | | -Some files to enhance Rake, including the Autumnal Rdoc template and some scripts. |
41 | | -
|
42 | | -
|
43 | | -== test - Tests |
44 | | -
|
45 | | -In the subfolder scanners/ are the scanners tests. |
46 | | -Each language has its own subfolder and sub-suite. |
47 | | -
|
48 | | -Run with <code>rake test</code>. |
| 1 | += CodeRay - folder structure |
| 2 | + |
| 3 | +== bench - Benchmarking system |
| 4 | + |
| 5 | +All benchmarking stuff goes here. |
| 6 | + |
| 7 | +Test inputs are stored in files named <code>example.<lang></code>. |
| 8 | +Test outputs go to <code>bench/test.<encoder-default-file-extension></code>. |
| 9 | + |
| 10 | +Run <code>bench/bench.rb</code> to get a usage description. |
| 11 | + |
| 12 | +Run <code>rake bench</code> to perform an example benchmark. |
| 13 | + |
| 14 | + |
| 15 | +== bin - Scripts |
| 16 | + |
| 17 | +Executional files for CodeRay. |
| 18 | + |
| 19 | +coderay:: The CodeRay executable. |
| 20 | + |
| 21 | +== demo - Demos and functional tests |
| 22 | + |
| 23 | +Demonstrational scripts to show of CodeRay's features. |
| 24 | + |
| 25 | +Run them as functional tests with <code>rake test:demos</code>. |
| 26 | + |
| 27 | + |
| 28 | +== etc - Lots of stuff |
| 29 | + |
| 30 | +Some addidtional files for CodeRay, mainly graphics and Vim scripts. |
| 31 | + |
| 32 | + |
| 33 | +== lib - CodeRay library code |
| 34 | + |
| 35 | +This is the base directory for the CodeRay library. |
| 36 | + |
| 37 | + |
| 38 | +== rake_helpers - Rake helper libraries |
| 39 | + |
| 40 | +Some files to enhance Rake, including the Autumnal Rdoc template and some scripts. |
| 41 | + |
| 42 | + |
| 43 | +== test - Tests |
| 44 | + |
| 45 | +In the subfolder scanners/ are the scanners tests. |
| 46 | +Each language has its own subfolder and sub-suite. |
| 47 | + |
| 48 | +Run with <code>rake test</code>. |
0 commit comments