Skip to content

Commit

Permalink
convert english README from rdoc to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
flavorjones committed May 23, 2024
1 parent fa5e81c commit 3c10b0d
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 63 deletions.
2 changes: 1 addition & 1 deletion Manifest.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ DOCUMENTATION.en.rdoc
DOCUMENTATION.ja.rdoc
Manifest.txt
README.ja
README.rdoc
README.md
Rakefile
bin/rex
lib/rexical.rb
Expand Down
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Rexical

* http://github.com/sparklemotion/rexical

## DESCRIPTION

Rexical is a lexical scanner generator that is used with Racc to generate Ruby programs. Rexical is
written in Ruby.


## SYNOPSIS

Several examples of Rexical grammar files are provided in the sample directory.

Here is an example of a lexical definition:

class Sample
macro
BLANK [\ \t]+
rule
{BLANK} # no action
\d+ { [:digit, text.to_i] }
\w+ { [:word, text] }
\n
. { [text, text] }
end

Here are examples of the command line usage:

$ rex sample1.rex --stub
$ ruby sample1.rex.rb sample1.c

$ rex sample2.rex --stub
$ ruby sample2.rex.rb sample2.bas

$ racc calc3.racc
$ rex calc3.rex
$ ruby calc3.tab.rb

The description files for lexical analysis in the sample directory are the files ending with the
.rex extension.

## REQUIREMENTS

* ruby version 1.8.x or later.

## INSTALL

* sudo gem install rexical

## LICENSE

Rexical is distributed under the terms of the GNU Lesser General Public License version 2. Note that
you do NOT need to follow LGPL for your own parser (Rexical outputs). You can provide those files
under any licenses you want.

See COPYING for more details.
60 changes: 0 additions & 60 deletions README.rdoc

This file was deleted.

4 changes: 2 additions & 2 deletions rexical.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Gem::Specification.new do |s|

s.executables = ["rex"]

s.rdoc_options = ["--main", "README.rdoc"]
s.extra_rdoc_files = ["CHANGELOG.md", "DOCUMENTATION.en.rdoc", "DOCUMENTATION.ja.rdoc", "README.rdoc"]
s.rdoc_options = ["--main", "README.md"]
s.extra_rdoc_files = ["CHANGELOG.md", "DOCUMENTATION.en.rdoc", "DOCUMENTATION.ja.rdoc", "README.md"]

s.files = File.read("Manifest.txt").split("\n")

Expand Down

0 comments on commit 3c10b0d

Please sign in to comment.