Code Monkey home page Code Monkey logo

generate-indices's Introduction

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.

generate-indices's People

Contributors

markkolich avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.