Remark
======

[Back to Homepage of Kalle Rutanen][Back]

[Back]: http://kaba.hilvi.org

_Remark_ is a Python command-line script and a Python library to generate 
html documentation for software libraries. Remark is documented with Remark, 
the results of which you are inspecting right now. The version documented 
here is [[remark_version]]. The latest version can always be found from 
[here][RemarkHomepage].

[RemarkHomepage]: http://kaba.hilvi.org/remark

Usage
-----

From the command-line (Windows, Linux, Mac OS X, ...): 

	remark.py inputDirectory outputDirectory (option|file-glob)*

### Linux and Mac OS X

The shells on Linux and Mac OS X expand the globs (e.g `*.txt`) _before_ 
running an executable (unless the globs do not match anything in the 
current directory). Therefore, on the command-line the globs should always 
be  provided in the form `"*.txt"`, to defer the glob-expansion from the 
shell to Remark.

### Example

Perhaps the best example is to build the documentation of Remark itself. 
After obtaining the source code for Remark, assuming you are at the root
directory of the source code, run from the command-line

	remark.py . docs -v

The `-v` option produces additional progress information. The other used 
options can be found the `remark_options` file. The resulting documentation 
can be read by opening `docs/remark.htm`.

Installation
------------

In the following we will assume that Python 2.7 has been installed
properly, as described in [here][InstallPython]. In particular, we
assume that `pip` and `easy_install` have both been installed.

### Mac OS X

From the command-line, run

	sudo pip install remark

### Linux

From the command-line, run with administrator rights

	pip install remark

### Windows

From the command-line, run

	easy_install pillow
	pip install remark

[InstallPython]: http://docs.python-guide.org/en/latest/starting/installation/

Source code
-----------

The source code for Remark is hosted on [BitBucket][] 
in a [Mercurial][] repository. Assuming you have Mercurial installed, the 
repository can be cloned from the command-line by

	hg clone https://bitbucket.org/kaba2/remark

[BitBucket]: http://bitbucket.org/kaba2/remark
[Mercurial]: http://mercurial.selenic.com

Issue tracker
-------------

The issue tracker for Remark is hosted on Bitbucket in [here][RemarkBugs].

[RemarkBugs]: https://bitbucket.org/kaba2/remark/issues

[[Comment]]:
	The following is a javascript for Google Analytics by which we can
	monitor the visitor statistics of the Remark homepage.

[[Html]]:
	<script type="text/javascript">
	var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
	document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
	</script>
	<script type="text/javascript">
	try {
	var pageTracker = _gat._getTracker("UA-15174506-4");
	pageTracker._trackPageview();
	} catch(err) {}</script>

