This repository is for 2017-2 Software Engineering Term Project. This repository provides build script 'build.xml' to build mdparser program. It consists of:
- doc directory : It includes doc1.md ~ doc4.md which are md files sample for testing.
- lib directory : It includes .jar files which are used for Ant, Jacoco and JUnit.
- src directory : It includes .java files which are java programs for mdparser, and test programs.
- build.xml : It is used to build mdparser, test JUnit, and analyze Jacoco branch coverage.
Before start building, it is required that you have installed Ant in your computer
- For just compiling mdparser programs, simply command :
$ ant - If you want to run JUnit test for mdparser programs, command :
$ ant test - For creating output of Jacoco analysis, command :
$ ant cov-test - If you want to look at result graph and details of Jacoco with html file, command :
$ ant cov-report
-
USER COMMANDS
-
NAME
mdparser : parses .md file into html file. -
SYNOPSIS
mdparser FILE.md [FILE.html]
-
-
DESCRIPTION This manual page documents the mdparser command line functionality. It receives a .md file and converts it into a html file. Usage of mdparser are given below.
- mdparser source.md destination.html (converts source.md into a file named destination.html in stylish format) - mdparser source.md (assigns the same name with the source .md file if output file name is not given. In this case, returns source.html)*Note that at least one .md file must be specified