Skip to content

meltmedia/rodimus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rodimus Prime

#Rodimus

A Word to HTML5 Document Transformer

Build Status

meltmedia innovation project by @ctrimble and @jking90

#Installation

This project requires that the following to be preinstalled:

  • Homebrew 0.9.X - You can check your home homebrew version by running brew -v.
  • Maven 3.0.3 (or greater) - You can check your Maven version by running mvn -v.

Once all of the dependencies are installed, you can use Homebrew to install rodimus:

brew tap meltmedia/homebrew-meltmedia
brew install --HEAD rodimus

#Usage

To use rodimus, simply pass in the file to convert and an optional output directory:

rodimus <INPUT_FILE> [<OUTPUT_DIR>]

If no output directory is specified, then the output will be placed in a directory based on the name of the input file.

#Building this Project

This project requires Maven 3.0.3 or later to be installed. Use these steps to checkout and build the project:

git clone [email protected]:meltmedia/rodimus.git
cd rodimus
mvn clean install

Once you have the project built, you can execute the command line using:

./target/rodimus <INPUT_FILE> [<OUTPUT_DIR>]

#Adding Test Cases

src/test/resources/testCases contains a set of example input document and expected output directories. Simply add new input and output documents to this directory to define new test cases. For example, to add a new test for case-x, you would add input and output documents like this:

Input:

src/test/resources/testCases/case-x.docx

Expected Output:

src/test/resources/testCases/case-x/index.html
src/test/resources/testCases/case-x/img/image1.jpeg

About

A Document Transformer for Word Formats

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published