Minor changes + adding an HTML-version generated from reStructuredText.

This commit is contained in:
Johan Holmberg 2009-04-02 21:36:32 +00:00 committed by holmberg556
parent a07af9e11b
commit a145508390
2 changed files with 354 additions and 6 deletions

349
README.html Normal file
View File

@ -0,0 +1,349 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title>Cmdtest - a program for testing executable programs</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 5631 2008-08-24 13:01:23Z goodger $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left {
clear: left }
img.align-right {
clear: right }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
tt.literal {
color: #b33;
}
pre.literal-block, pre.doctest-block {
margin-left: 2em ;
x-background-color: #ddd;
background-color: #fec;
padding: 0.5em;
outline-style: dashed;
outline-width: 0.1em;
margin-right: 2em }
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="cmdtest-a-program-for-testing-executable-programs">
<h1 class="title">Cmdtest - a program for testing executable programs</h1>
<p>&quot;cmdtest&quot; is a program to test executable programs. Tests are written in
an &quot;xunit style&quot;, using assertions about created files, content of
standard output, exit code, etc. &quot;cmdtest&quot; is written in Ruby.
It consists of a main program and a number of library files.</p>
<div class="section" id="documentation">
<h1>Documentation</h1>
<p>A &quot;Cmdtest User Guide&quot; can be found in the file <a class="reference external" href="doc/cmdtest.html">doc/cmdtest.html</a>.
It is generated from the file &quot;cmdtest.txt&quot; which is written in
reStructuredText format.</p>
</div>
<div class="section" id="installation">
<h1>Installation</h1>
<p>No installation is needed to use &quot;cmdtest&quot;. The file
&quot;cmdtest.rb&quot; can be executed directly from where it is checked out.</p>
<p>But the program can also be installed. Use the following command:</p>
<pre class="literal-block">
$ svn co http://cmdtest.googlecode.com/svn/trunk cmdtest
$ cd cmdtest
$ ruby setup.rb # sudo may be needed
</pre>
<p>For details about options to <tt class="docutils literal"><span class="pre">setup.rb</span></tt> use <tt class="docutils literal"><span class="pre">ruby</span> <span class="pre">setup.rb</span> <span class="pre">--help</span></tt>
or see &lt;<a class="reference external" href="http://i.loveruby.net/en/projects/setup/doc/usage.html">http://i.loveruby.net/en/projects/setup/doc/usage.html</a>&gt;.</p>
</div>
<div class="section" id="license">
<h1>License</h1>
<p>&quot;cmdtest&quot; is released under the GNU General Public License version 3.
For details see the file <a class="reference external" href="COPYING.txt">COPYING.txt</a> in the same directory as this file.</p>
</div>
<div class="section" id="history">
<h1>History</h1>
<p>I got the idea to create &quot;cmdtest&quot; 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 &quot;unit tests&quot; 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
&quot;cmdtest&quot;.</p>
</div>
<div class="section" id="author">
<h1>Author</h1>
<p>&quot;cmdtest&quot; was created by Johan Holmberg &lt;holmberg556 at gmail dot com&gt;.</p>
</div>
</div>
<div class="footer">
<hr class="footer" />
<a class="reference external" href="README.txt">View document source</a>.
Generated on: 2009-04-02.
Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
</body>
</html>

View File

@ -4,15 +4,13 @@ Cmdtest - a program for testing executable programs
"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. It consists of a main program and a
number of library files.
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".
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.
@ -24,6 +22,7 @@ No installation is needed to use "cmdtest". The file
But the program can also be installed. Use the following command::
$ svn co http://cmdtest.googlecode.com/svn/trunk cmdtest
$ cd cmdtest
$ ruby setup.rb # sudo may be needed
@ -34,7 +33,7 @@ License
-------
"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.
For details see the file `<COPYING.txt>`_ in the same directory as this file.
History
-------