Commit a666ecb

author

mzj14

committed

update read me

1 parent 9c144a6 commit a666ecbCopy full SHA for a666ecb

File tree

+18

-5

lines changed

+18

-5

lines changed

Lines changed: 18 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,15 @@`
`1`	`1`	`## data_dependency_exploration`
`2`	`2`
`3`		`-TANE algorithm implementation for function dependency exploration`
	`3`	`+A TANE algorithm implementation for function dependency exploration`
	`4`	`+`
	`5`	`+Command line in this introduction is fully tested on Ubuntu 16.04`
`4`	`6`
`5`	`7`
`6`	`8`	`### Prerequisite`
`7`	`9`
`8`	`10`	`* python3(>=3.5.2)`
`9`		`-* pylint3(>=1.5.2)`
	`11`	+* pylint3(>=1.5.2), acquired by `sudo apt-get install pylint3`
	`12`	+* coverage(>= 4.3.4), acquired by `sudo pip3 install coverage`
`10`	`13`
`11`	`14`	`### Project structure`
`12`	`15`
`@@ -36,7 +39,11 @@ to generate documents for module details`
`36`	`39`
`37`	`40`	`#### main.py`
`38`	`41`
`39`		`-* This file is an example of using previous module`
	`42`	`+* An example of using above modules`
	`43`	`+`
	`44`	`+#### test.py`
	`45`	`+`
	`46`	`+* Test cased`
`40`	`47`
`41`	`48`	`Run`
`42`	`49`	```
`@@ -63,5 +70,11 @@ python3 main.py -i data/data.txt -o output.txt --breaker=,`
`63`	`70`	```
`64`	`71`	to get function dependencies in `output.txt` for table in `data/data.txt`
`65`	`72`
`66`		`-#### Test`
`67`		`-//TODO:`
	`73`	`+#### Run test`
	`74`	`+Run`
	`75`	+```
	`76`	`+coverage run test.py`
	`77`	`+coverage html`
	`78`	+```
	`79`	`+to get a coverage report of the test`
	`80`	`+`

Comments

(0)