update readme #18
update readme #18
Conversation
README.md
Outdated
|
|
||
| ## Installation | ||
| Make sure you have `git` and `pip` installed. You can download and unzip the following repositories: | ||
| - git@github.com:INT-NIT/elabforms_INTProjects.git |
There was a problem hiding this comment.
this line should be removed... this is the general documentation on how to use elabforms, it should not point to a private repository!
README.md
Outdated
| ## Installation | ||
| Make sure you have `git` and `pip` installed. You can download and unzip the following repositories: | ||
| - git@github.com:INT-NIT/elabforms_INTProjects.git | ||
| - git@github.com:INT-NIT/elabforms_BIDSMetadata.git |
There was a problem hiding this comment.
here, you say "you can download and unzip blahblahbla", but you don't explain why and for what... so I'm not sure it should be here (which is mostly a doc for the installation); it probably should be in a user / datamanager doc... so we should overall discuss the structure of the documentation(s) (what's here? what's on sphynx? etc.) to decide what content to put where...
WDYT?
There was a problem hiding this comment.
i'm not sure I fully understand what you mean. Do you mean that I need to provide all the necessary information so that the data manager or anyone else can use the package? If that's the case, then I should mention where we get our template parts from, right
There was a problem hiding this comment.
let me explain: here, you're not writing a doc for the INT user or the INT data manager... you're writing a doc for anybody who will want to use the package (think about another lab somewhere else)... so what you describe in this readme should be limited to this, and the examples adapted to this generic context! in this doc, there could be a description of a finalized template form with its three types of contents: 1. modality-agnostic metadata that corresponds to the BIDS specs (and where to find it, i.e in the elabform_bidsmetadata repo), 2. idem with the modality-specific info, 3. the customized parts (that the user can decide to store and manage however s.he wants)
for the INT data manager, there should be another doc somewhere else, specific for our institute, that refers to the generic one and that provides only two extra info: where to find the INT project specific template parts, and where to store the full templates... (i.e in our private repository)
There was a problem hiding this comment.
Okay, I get it. But I think it would be unnecessary to describe the structure of the final output in detail. All those details aren’t really needed, because in the end, users will manage it however they want. So I think the example provided at the bottom of the README is sufficient. I’ll just explain that, to have a source of template parts, they need to concatenate them.
README.md
Outdated
| ## Installation | ||
| Make sure you have `git` and `pip` installed. You can download and unzip the following repositories: | ||
| - git@github.com:INT-NIT/elabforms_INTProjects.git | ||
| - git@github.com:INT-NIT/elabforms_BIDSMetadata.git |
There was a problem hiding this comment.
let me explain: here, you're not writing a doc for the INT user or the INT data manager... you're writing a doc for anybody who will want to use the package (think about another lab somewhere else)... so what you describe in this readme should be limited to this, and the examples adapted to this generic context! in this doc, there could be a description of a finalized template form with its three types of contents: 1. modality-agnostic metadata that corresponds to the BIDS specs (and where to find it, i.e in the elabform_bidsmetadata repo), 2. idem with the modality-specific info, 3. the customized parts (that the user can decide to store and manage however s.he wants)
for the INT data manager, there should be another doc somewhere else, specific for our institute, that refers to the generic one and that provides only two extra info: where to find the INT project specific template parts, and where to store the full templates... (i.e in our private repository)
|
|
||
| Or you can clone the repositories using `git`. | ||
| You will need `template_part` files to generate the final template. | ||
| These files are located in the `elabforms_INTProjects` and `elabforms_BIDSMetadata` repositories — private Git repositories at NIT. |
There was a problem hiding this comment.
you still mention the INT resources (private repo & co)... this should not be here!
I will correct it myself so that we can merge quickly...
|
also, the name of your last commit is "sphyx doc"... not a good name for this commit ;) |
3 participants
No description provided.