Change checkout example to show use of Mercurial.

We changed revision control system from Subversion recently.
This commit is contained in:
Johan Holmberg
2009-06-16 20:58:16 +02:00
parent c15e9e5ae4
commit a533ee1300
3 changed files with 36 additions and 28 deletions

View File

@ -295,24 +295,24 @@ ul.auto-toc {
<div class="document" id="cmdtest-a-program-for-testing-executable-programs"> <div class="document" id="cmdtest-a-program-for-testing-executable-programs">
<h1 class="title">Cmdtest - a program for testing executable programs</h1> <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 <p><a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a> is a program to test executable programs. Tests are written in
an &quot;xunit style&quot;, using assertions about created files, content of an &quot;xunit style&quot;, using assertions about created files, content of
standard output, exit code, etc. &quot;cmdtest&quot; is written in Ruby. standard output, exit code, etc. <a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a> is written in Ruby.
It consists of a main program and a number of library files.</p> It consists of a main program and a number of library files.</p>
<div class="section" id="documentation"> <div class="section" id="documentation">
<h1>Documentation</h1> <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>. <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 It is generated from the file <tt class="docutils literal"><span class="pre">cmdtest.txt</span></tt> which is written in
reStructuredText format. There is also an <a class="reference external" href="examples">examples</a> directory with <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> format. There is also an <a class="reference external" href="examples">examples</a> directory with
some real-world examples of using &quot;cmdtest&quot;.</p> some real-world examples of using <a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a>.</p>
</div> </div>
<div class="section" id="installation"> <div class="section" id="installation">
<h1>Installation</h1> <h1>Installation</h1>
<p>No installation is needed to use &quot;cmdtest&quot;. The file <p>No installation is needed to use <a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a>. The file <tt class="docutils literal"><span class="pre">cmdtest.rb</span></tt> can
&quot;cmdtest.rb&quot; can be executed directly from where it is checked out.</p> be executed directly from where it is checked out or unpacked. But the
<p>But the program can also be installed. Use the following command:</p> program can also be installed. Use the following command:</p>
<pre class="literal-block"> <pre class="literal-block">
$ svn co http://cmdtest.googlecode.com/svn/trunk cmdtest $ hg clone https://cmdtest.googlecode.com/hg/ cmdtest
$ cd cmdtest $ cd cmdtest
$ ruby setup.rb # sudo may be needed $ ruby setup.rb # sudo may be needed
</pre> </pre>
@ -321,28 +321,28 @@ or see &lt;<a class="reference external" href="http://i.loveruby.net/en/projects
</div> </div>
<div class="section" id="license"> <div class="section" id="license">
<h1>License</h1> <h1>License</h1>
<p>&quot;cmdtest&quot; is released under the GNU General Public License version 3. <p><a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a> 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> 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>
<div class="section" id="history"> <div class="section" id="history">
<h1>History</h1> <h1>History</h1>
<p>I got the idea to create &quot;cmdtest&quot; when I was using and making changes to Cons, <p>I got the idea to create <a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a> when I was using and making changes to <a class="reference external" href="http://www.dsmit.com/cons/">Cons</a>,
the make-replacement written in Perl. The program had tests written the make-replacement written in Perl. The program had tests written
using the Perl module Test::Cmd. Later I developed other using the Perl module Test::Cmd. Later I developed other
programs that also needed some kind of &quot;unit tests&quot; for the executables. 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 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 comfortable with. So I started to develop my own tool, and the result was
&quot;cmdtest&quot;.</p> <a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a>.</p>
</div> </div>
<div class="section" id="author"> <div class="section" id="author">
<h1>Author</h1> <h1>Author</h1>
<p>&quot;cmdtest&quot; was created by Johan Holmberg &lt;holmberg556 at gmail dot com&gt;.</p> <p><a class="reference external" href="http://cmdtest.googlecode.com">Cmdtest</a> was created by Johan Holmberg &lt;holmberg556 at gmail dot com&gt;.</p>
</div> </div>
</div> </div>
<div class="footer"> <div class="footer">
<hr class="footer" /> <hr class="footer" />
<a class="reference external" href="README.txt">View document source</a>. <a class="reference external" href="README.txt">View document source</a>.
Generated on: 2009-04-02. Generated on: 2009-06-16.
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. 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> </div>

View File

@ -2,28 +2,27 @@
Cmdtest - a program for testing executable programs 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 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. It consists of a main program and a number of library files.
Documentation 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 It is generated from the file ``cmdtest.txt`` which is written in
reStructuredText format. There is also an `<examples>`_ directory with reStructuredText_ format. There is also an `<examples>`_ directory with
some real-world examples of using "cmdtest". some real-world examples of using Cmdtest_.
Installation Installation
------------ ------------
No installation is needed to use "cmdtest". The file No installation is needed to use Cmdtest_. The file ``cmdtest.rb`` can
"cmdtest.rb" can be executed directly from where it is checked out. 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:: $ hg clone https://cmdtest.googlecode.com/hg/ cmdtest
$ svn co http://cmdtest.googlecode.com/svn/trunk cmdtest
$ cd cmdtest $ cd cmdtest
$ ruby setup.rb # sudo may be needed $ ruby setup.rb # sudo may be needed
@ -33,22 +32,26 @@ or see <http://i.loveruby.net/en/projects/setup/doc/usage.html>.
License 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. For details see the file `<COPYING.txt>`_ in the same directory as this file.
History 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 the make-replacement written in Perl. The program had tests written
using the Perl module Test::Cmd. Later I developed other using the Perl module Test::Cmd. Later I developed other
programs that also needed some kind of "unit tests" for the executables. 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 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 comfortable with. So I started to develop my own tool, and the result was
"cmdtest". Cmdtest_.
Author Author
------ ------
"cmdtest" was created by Johan Holmberg <holmberg556 at gmail dot com>. Cmdtest_ was created by Johan Holmberg <holmberg556 at gmail dot com>.
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Cmdtest: http://cmdtest.googlecode.com
.. _Cons: http://www.dsmit.com/cons/

View File

@ -10,3 +10,8 @@ task "html" do
sh "rst2html.py -gds --stylesheet doc/rst.css doc/cmdtest.txt doc/cmdtest.html" sh "rst2html.py -gds --stylesheet doc/rst.css doc/cmdtest.txt doc/cmdtest.html"
end end
desc "generate HTML README"
task "readme-html" do
sh "rst2html.py -gds --stylesheet doc/rst.css README.txt README.html"
end