Bläddra i källkod

Update README

sfmig 1 år sedan
förälder
incheckning
9eed9fca35
1 ändrade filer med 28 tillägg och 1 borttagningar
  1. 28 1
      README.md

+ 28 - 1
README.md

@@ -1,3 +1,30 @@
 # ethology-test-data
 
-Test data for the ethology Python package.
+Test data for the ethology Python package.
+
+## Adding or editing data
+
+Remember to update the file registry for `pooch` after adding or editing the data!
+
+To do so, run the following from the root of the GIN repository:
+
+0- Ensure all the content is downloaded locally:
+
+```bash
+gin download --content
+```
+
+1- After editing or adding any files, run the Python script to generate the `file-registry.tx`t file:
+
+```bash
+python get_sha256_hashes.py
+```
+
+2- Commit the changes to the GIN repository
+
+```bash
+gin commit -m "Update file and file-registry.txt" <path-to-edited-or-updated-file> file-registry.txt
+gin upload <path-to-edited-or-updated-file> file-registry.txt
+```
+
+For further details, please see the [GIN HowTo guide](https://howto.neuroinformatics.dev/open_science/GIN-repositories.html).