Skip to content

Commit 184cf07

Browse files
authored
More info in the readme
1 parent 69ec5da commit 184cf07

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# data
22
A repository that can be used to attach anonymized data for testing
3+
4+
## usage
5+
6+
The github releases feature for this repository is used to present binary datasets that can be easily downloaded for use in testing.
7+
8+
For example this command downloads a single series of an MR scan:
9+
```
10+
curl -L "https://github.com/dcmjs-org/data/releases/download/MRHead/MRHead.zip" > MRHead.zip
11+
```
12+
13+
If you have comments or questions about the data, such as how the data is encoded or what the fields mean, please open an issue on this repository and reference the particular dataset.
14+
15+
## contributing
16+
17+
Make abolutely sure you can share the data according to any applicable regulations (e.g. policies of your employer or government). Also be sure you are comfortable sharing the data with the general pubic because it may get used for purposes over which you have no control.
18+
19+
To share:
20+
* You need to join this repository, which means getting to know one of the dcmjs-org organization owners well enough that they trust you to contribute data legitimately
21+
* Create a new release on this repository
22+
* Attach the data (e.g. drag and drop a zip file)
23+
* Provide an informative description

0 commit comments

Comments
 (0)