diff --git a/README.html b/README.html index 18de068..9be7ec3 100644 --- a/README.html +++ b/README.html @@ -295,24 +295,24 @@ ul.auto-toc {

Cmdtest - a program for testing executable programs

-

"cmdtest" is a program to test executable programs. Tests are written in +

Cmdtest is a program to test executable programs. Tests are written in an "xunit style", using assertions about created files, content of -standard output, exit code, etc. "cmdtest" is written in Ruby. +standard output, exit code, etc. Cmdtest is written in Ruby. It consists of a main program and a number of library files.

Documentation

A "Cmdtest User Guide" can be found in the file doc/cmdtest.html. -It is generated from the file "cmdtest.txt" which is written in -reStructuredText format. There is also an examples directory with -some real-world examples of using "cmdtest".

+It is generated from the file cmdtest.txt which is written in +reStructuredText format. There is also an examples directory with +some real-world examples of using Cmdtest.

Installation

-

No installation is needed to use "cmdtest". The file -"cmdtest.rb" can be executed directly from where it is checked out.

-

But the program can also be installed. Use the following command:

+

No installation is needed to use Cmdtest. The file cmdtest.rb can +be executed directly from where it is checked out or unpacked. But the +program can also be installed. Use the following command:

-$ svn co http://cmdtest.googlecode.com/svn/trunk cmdtest
+$ hg clone https://cmdtest.googlecode.com/hg/ cmdtest
 $ cd cmdtest
 $ ruby setup.rb            # sudo may be needed
@@ -321,28 +321,28 @@ or see <

License

-

"cmdtest" is released under the GNU General Public License version 3. +

Cmdtest is released under the GNU General Public License version 3. For details see the file COPYING.txt in the same directory as this file.

History

-

I got the idea to create "cmdtest" when I was using and making changes to Cons, +

I got the idea to create Cmdtest when I was using and making changes to Cons, the make-replacement written in Perl. The program had tests written using the Perl module Test::Cmd. Later I developed other programs that also needed some kind of "unit tests" for the executables. I looked for existing tools but could not find anything that I was completely comfortable with. So I started to develop my own tool, and the result was -"cmdtest".

+Cmdtest.

Author

-

"cmdtest" was created by Johan Holmberg <holmberg556 at gmail dot com>.

+

Cmdtest was created by Johan Holmberg <holmberg556 at gmail dot com>.

View document source. -Generated on: 2009-04-02. +Generated on: 2009-06-16. Generated by Docutils from reStructuredText source.
diff --git a/README.txt b/README.txt index 9bbf1d4..0af4480 100644 --- a/README.txt +++ b/README.txt @@ -2,28 +2,27 @@ Cmdtest - a program for testing executable programs =================================================== -"cmdtest" is a program to test executable programs. Tests are written in +Cmdtest_ is a program to test executable programs. Tests are written in an "xunit style", using assertions about created files, content of -standard output, exit code, etc. "cmdtest" is written in Ruby. +standard output, exit code, etc. Cmdtest_ is written in Ruby. It consists of a main program and a number of library files. Documentation ------------- A "Cmdtest User Guide" can be found in the file ``_. -It is generated from the file "cmdtest.txt" which is written in -reStructuredText format. There is also an ``_ directory with -some real-world examples of using "cmdtest". +It is generated from the file ``cmdtest.txt`` which is written in +reStructuredText_ format. There is also an ``_ directory with +some real-world examples of using Cmdtest_. Installation ------------ -No installation is needed to use "cmdtest". The file -"cmdtest.rb" can be executed directly from where it is checked out. +No installation is needed to use Cmdtest_. The file ``cmdtest.rb`` can +be executed directly from where it is checked out or unpacked. But the +program can also be installed. Use the following command:: -But the program can also be installed. Use the following command:: - - $ svn co http://cmdtest.googlecode.com/svn/trunk cmdtest + $ hg clone https://cmdtest.googlecode.com/hg/ cmdtest $ cd cmdtest $ ruby setup.rb # sudo may be needed @@ -33,22 +32,26 @@ or see . License ------- -"cmdtest" is released under the GNU General Public License version 3. +Cmdtest_ is released under the GNU General Public License version 3. For details see the file ``_ in the same directory as this file. History ------- -I got the idea to create "cmdtest" when I was using and making changes to Cons, +I got the idea to create Cmdtest_ when I was using and making changes to Cons_, the make-replacement written in Perl. The program had tests written using the Perl module Test::Cmd. Later I developed other programs that also needed some kind of "unit tests" for the executables. I looked for existing tools but could not find anything that I was completely comfortable with. So I started to develop my own tool, and the result was -"cmdtest". +Cmdtest_. Author ------ -"cmdtest" was created by Johan Holmberg . +Cmdtest_ was created by Johan Holmberg . + +.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _Cmdtest: http://cmdtest.googlecode.com +.. _Cons: http://www.dsmit.com/cons/ diff --git a/Rakefile b/Rakefile index 6d6b26e..d021345 100644 --- a/Rakefile +++ b/Rakefile @@ -10,3 +10,8 @@ task "html" do sh "rst2html.py -gds --stylesheet doc/rst.css doc/cmdtest.txt doc/cmdtest.html" end +desc "generate HTML README" +task "readme-html" do + sh "rst2html.py -gds --stylesheet doc/rst.css README.txt README.html" +end +