Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianquek committed Jun 26, 2015
1 parent fcf9e00 commit f6624fd
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <DIR>` - Collate all files within `<DIR>` including subfolders
* `collate from <DIR> only` / `collate only from <DIR>` - Only collate files in `<DIR>`
* `collate from <DIR> 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
Expand Down

0 comments on commit f6624fd

Please sign in to comment.