Skip to content

Commit 0ad93f4

Browse files
committed
ENH: update README
1 parent c073e93 commit 0ad93f4

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

Diff for: README.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
1-
#SlicerDeveloperToolsForExtensions
1+
# SlicerDeveloperToolsForExtensions
22

33

4-
##What is it?
4+
## What is it?
55

66
This repository contains 3D Slicer extensions that offers different tools to help developers when they develop Slicer extensions:
77
- Developer Tools For Extensions: It allows one to manually install extensions from an archive (*.zip or *.tar.gz). These archives can either be created locally when one creates their own extensions (this tools can help the developer to verify that their extension is correctly packaged). It can also be convenient to distribute your Slicer extensions on your own website, or privately. It also allows to directly load a scripted module while Slicer is already running.
88
- Extension Download Statistics: It allows developers to know how many times their extensions have been downloaded.
99

10-
##License
10+
## Command line interface
1111

12-
See License.txt
12+
The CLI mode allows to collect downloads stats for the specified or all of the
13+
extensions and save the results in CSV or JSON format, from the command line.
1314

14-
##More information
15+
Note that you will need to run the script via Slicer using `--python-script` flag
16+
to access this mode.
1517

16-
More information about Slicer on http://www.slicer.org/
18+
Example usage:
1719

20+
```
21+
/Applications/Slicer.app/Contents/MacOS/Slicer --disable-cli-modules --no-main-window --no-splash \
22+
--python-script ~/github/SlicerDeveloperToolsForExtensions/ExtensionStats/ExtensionStats.py \
23+
-e SlicerRT --output-csv stats.csv --output-json stats.json
24+
```
1825

26+
## License
27+
28+
See License.txt
29+
30+
## More information
31+
32+
More information about Slicer on http://www.slicer.org/

0 commit comments

Comments
 (0)