From f6624fd5bc8cd5cb3c9517d4537d7a2c1432a770 Mon Sep 17 00:00:00 2001 From: Sebastian Quek Date: Fri, 26 Jun 2015 16:48:11 +0800 Subject: [PATCH] Updated README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 422af8c..5e42d6b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,26 @@ -#Collate +# Collate Collate is a tool to find out the contributions of each contributor of the project. + It will export collated files formatted in Markdown. Example collated file: [Sebastian Quek.md](collated/Sebastian Quek.md) -##Resources +## Usage +Include `@author` tags to the areas of code you wrote. +```java +// @author John Doe +public class MyCustomClass { + + public MyCustomClass() { + System.out.println("hello"); + } +} +``` + +Commands: +* `collate from ` - Collate all files within `` including subfolders +* `collate from only` / `collate only from ` - Only collate files in `` +* `collate from include java, css` - Only collate java and css files + +## Resources * [Eclipse] - IDE for java * [e(fx)clipse] - Eclipse add-on which adds JavaFX tools such as a CSS editor with all the JavaFX properties * [Scene Builder 8.0.0] - For laying out JavaFX scenes