diff --git a/README.md b/README.md index 56bcca5..53e261f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## Sisyphe-GO -Sisyphe is a generic Golang recursive folder analyser terminal application +Sisyphe-go is a generic Golang recursive folder analyser terminal application ### Requirements @@ -64,16 +64,16 @@ ### How it works ? -Just start Sisyphe on a folder with any files in it. +Just start Sisyphe-go on a folder with any files in it. -`go run . ~/Documents/customfolder/corpus -n corpusname -o outputpath` +`go run . -p ~/Documents/customfolder/corpus -n corpusname -o outputpath` -`go run . ~/Documents/customfolder/corpus -n corpusname -c ~/Documents/customfolder/corpusResources -o outputpath` +`go run . -p ~/Documents/customfolder/corpus -n corpusname -c ~/Documents/customfolder/corpusResources -o outputpath` -Sisyphe is now working in background with all your computer thread. +Sisyphe-go is now working in background with all your computer thread. Just take a coffee and wait , it will prevent you when it's done :) -The results of sisyphe are present @ `sisyphe/out/{timestamp}-corpusName/` (errors,info,duration..) +The results of sisyphe-go are present in `outputpath/{timestamp}-corpusName/` (errors,info,duration..) ### Test @@ -86,6 +86,6 @@ ### Modules - PDF - Usage of poppler lib (`pdftotext` and `pdfinfo`) + Usage of pdf lib (`pdftotext` and `pdfinfo`) - XML Usage of xml lib (`xmlstarlet` and `xmllint`)