浏览代码

Update README

sfmig 1 年之前
父节点
当前提交
db10d0d241
共有 1 个文件被更改,包括 6 次插入5 次删除
  1. 6 5
      README.md

+ 6 - 5
README.md

@@ -2,21 +2,22 @@
 
 Test data for the crabs-exploration package
 
-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:
+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:
 ```
 gin download --content
 ```
 
-
-1- run the Python script to generate the `file-registry.txt` file:
+1- After editing or adding any files, run the Python script to generate the `file-registry.txt` file:
 ```
 python get_sha256_hashes.py
 ```
 
 2- Commit the changes to the GIN repository
 ```
-gin commit -m "Update file-registry.txt" file-registry.txt
-gin upload file-registry.txt
+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
 ```