Skip to content

Commit

Permalink
Update to README.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
GShah9 committed Mar 2, 2017
1 parent c5cf30a commit 3426abf
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Postcode Validator

This program is built on `Java 8` and is dependant on Stream API.
It also requires `maven 3.3.9+`

The code can be compiled and executed using maven via commandline or latest java supported IDE.

Following line is used to compile the code (using command-line):
```sh
$ cd PostCode
$ mvn clean install
```

To run the tests:
```sh
$ mvn test
```

To run the main program to read csv file and create respective valid/invalid files:
```sh
$ mvn exec:java
```
**You would need to enter number '1' or '2' to perform the task**

2 changes: 1 addition & 1 deletion src/main/resources/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the place where main import_data.csv is supposed to be present
# This is the place where main `import_data.csv` is supposed to be present
2 changes: 1 addition & 1 deletion src/test/resources/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the place where test import_data.csv is supposed to be present
# This is the place where test `import_data.csv` is supposed to be present

0 comments on commit 3426abf

Please sign in to comment.