Generate HTML indices (index.html pages) for a set of nested directories.
Scala
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
src/main/scala
.gitignore
LICENSE
README.md
build.sbt

README.md

generate-indices

Trivial Scala project to generate HTML indices (index.html pages) for a set of nested directories.

Meh.

Using

Download the latest runnable JAR here.

The JAR is self-contained courtesy of the sbt-onejar plugin. Although the project is written in Scala, you don't need Scala to run it -- just a working JVM.

Let's say you want to generate index.html pages for all files and directories under directory foobar, then run ...

#~/> java -jar generate-indices-0.3-one-jar.jar foobar

Building

This project is built using SBT.

To clone+build this project, you must have SBT installed and configured on your computer.

First, clone the repository.

#~> git clone git://github.com/markkolich/generate-indices.git

Second, run SBT from within generate-indices.

#~> cd generate-indices
#~/generate-indices> sbt
...
>

You will see an SBT > prompt once all dependencies are resolved and the project is loaded.

Lastly, in SBT, run one-jar to compile and package the self-contained runnable JAR.

> one-jar
...
[info] Compiling 1 Scala source to ~/generate-indices/target/classes...
[info] Packaging ~/generate-indices/target/generate-indices-0.3.jar ...
[info] Done packaging.
[info] Packaging ~/generate-indices/target/generate-indices-0.3-one-jar.jar ...
[info] Done packaging.
[success] Total time: 9 s

Note the resulting one-jar enabled JAR is placed into the generate-indices/target directory.

In a separate shell, attempt to run your newly created JAR.

#~> java -jar ~/generate-indices/target/generate-indices-0.3-one-jar.jar
Usage: generate-indices.jar [root dir name]

Yay!

Licensing

Copyright (c) 2012 Mark S. Kolich

All code in this project is freely available for use and redistribution under the MIT License.

See LICENSE for details.