Update and rename repo_structure.md to repo_structure.txt

norkorr · Dec 14, 2020 · 249daf0 · 249daf0
1 parent b2956ab
commit 249daf0
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 33 deletions.
diff --git a/repo_structure.md b/repo_structure.md
diff --git a/repo_structure.txt b/repo_structure.txt
@@ -0,0 +1,34 @@
+-------------------
+Structure for collection-repositories in the organization NorKorr on GitHub
+-------------------
+
+! Not all repositories will have all directories listed below
+! All repositories must have a README.md, a LICENSE.txt and a CONTRIBUTING.md file on the top level
+! All repositories should have a /data directory containing the CMIF files and a README.txt documenting the CMIF files
+
+norkorr/repo-name. 
+  |-- README.md. 
+  |-- LICENSE.txt (CC-BY4.0 or CC-BY-ND4.0). 
+  |-- CONTRIBUTING.md (use template). 
+  |-- .gitignore (for files that are not tracked, like .docx or .DS_Store. 
+
+  |-- /data. 
+     |-- README.txt (use template). 
+     |-- CMIF (.xml). 
+     |-- .csv. 
+
+  |-- /src (source). 
+     |-- .ipynb (Jupyter Notebook). 
+     |-- .py (Python script)  
+     |-- .xslt. 
+
+  |-- /results. 
+     |-- README.txt  
+     |-- .gephi. 
+
+  |-- /images. 
+     |-- README.md. 
+     |-- .png. 
+     |-- .jpg. 
+
+