Skip to content

Commit ce6aec2

Browse files
authored
Update README.md
1 parent f0b3231 commit ce6aec2

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,19 @@ Installation is easy, as SSRI is on PyPi, so simply run `pip install ssri`. Alte
2323
There is a simple example setup in the `Example/` folder, which shows a simple way of using `ssri`, so this is more of a run through of the argument options:
2424

2525
`inputFile` is one or more files, or a directory (if the `-d` flag is passed).
26+
2627
`-h` prints out the help menu.
28+
2729
`-d` specifies a directory to run through recursively (this will grab all the files in any subdir, keep the order/layout).
30+
2831
`-t` specifies the directory to grab the templates from, if it is not provided it grabs templates from the input directory (or if the input was not a directory it uses the current directory).
32+
2933
`-o` is the directory to output the generated files to, if not provided it outputs to a directory `/output`.
34+
3035
`--no-warnings` silences any warnings, and just runs without worrying if it overwrites any files.
36+
3137
`-v` explains what the script is doing, turns on verbose mode
38+
3239
`-c` copies the entire source (input) directory to the output directory, the `-d` flag must be used, and only one directory may be provided
3340

3441
#### Tips

0 commit comments

Comments
 (0)