Add README.md to log/ and metadata/

mjanez · Apr 21, 2023 · fc4ee51 · fc4ee51
1 parent 1d37898
commit fc4ee51
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,8 @@ pycsw.conf
 .vscode
 __pycache__
 log/*
+!log/README.md
 metadata/*
+!metadata/README.md
 samples
 .env
diff --git a/log/README.md b/log/README.md
@@ -0,0 +1,2 @@
+# Log folder
+This folder is used to store logs generated by `ckan2pycsw` script. Logs are essential for debugging and tracing the execution of the code. By keeping logs, you can track the behavior of your code over time, identify errors and performance issues, and improve the overall quality of your code.
diff --git a/metadata/README.md b/metadata/README.md
@@ -0,0 +1,5 @@
+# ISO19139 Metadata files
+This folder is used to store ISO19139 metadata files (`XML`). Metadata is essential for describing and providing context to your data. By keeping metadata files, you can ensure that your data is properly documented, discoverable, and reusable.
+
+## Usage
+`ckan2pycsw` save your ISO19139 metadata files in this folder. Each file should correspond to a dataset or resource that you want to describe. The filename should be descriptive and unique to the dataset or resource.