Create Markdown Readme instead

Author: adam3smith

dvcurator/assets/README.md

@@ -0,0 +1,27 @@
+# $title
+
+## Suggested Citation
+Please cite any data used from this data project as follows: 
+
+$citation
+
+## Description
+$description
+
+## File Access
+$access
+
+## Included Files
+This collection contains the following $any_folders:
+
+$files
+
+## Data Processing Note
+
+The data were processed according to the Qualitative Data Repository's curation policy. All files were checked for integrity. Files were checked to make sure they match documentation and consistent file names were applied. PDF files were converted to PDF/A using Adobe Acrobat Pro DC Version 2022.001.20117, XMP tags edited using pikepdf, and enhanced for WCAG accessibility compliance.
+
+[edit data processing note according to processing steps, note everything we did with the data -- e.g., add notes on de-identification (2.3.1.), copyright (2.3.2.), and other file conversions (2.4.) -- and update software versions as necessary]
+
+-------
+
+These data were obtained from the Qualitative Data Repository (QDR - http://qdr.syr.edu), a dedicated archive for storing and sharing digital data (and accompanying documentation) generated or collected through qualitative and multi-method research in the social sciences. QDR is supported by the National Science Foundation. Please consult QDR's General Terms and Conditions of Use (https://qdr.syr.edu/termsandconditions). 

dvcurator/readme.py

@@ -15,7 +15,7 @@ def clean_html_tags(text):
 
 def generate_readme(metadata, folder, token=None):
     """
-    Generate README.txt file. 
+    Generate README.md file. 
     
     This function uses the template assets/README.txt
 
@@ -36,7 +36,7 @@ def generate_readme(metadata, folder, token=None):
     citation = dvcurator.dataverse.get_citation(metadata)
     folder = dvcurator.fs.current_step(folder)
 
-    readme_name = "README_" + dvcurator.rename.last_name_prefix(citation) + ".txt"
+    readme_name = "README_" + dvcurator.rename.last_name_prefix(citation) + ".md"
     readme_name = unicodedata.normalize('NFKD', readme_name).encode('ascii', 'ignore').decode('ascii')
     new_path = os.path.join(folder, "..", readme_name)
     if os.path.exists(new_path):
@@ -80,9 +80,9 @@ def generate_readme(metadata, folder, token=None):
 
     # the location of the template differs if this is a compiled pyinstaller file or run directly
     if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'):
-        path = os.path.join(sys._MEIPASS, "assets", "README.txt")
+        path = os.path.join(sys._MEIPASS, "assets", "README.md")
     else:
-        path = resource_filename("dvcurator", "assets/README.txt")
+        path = resource_filename("dvcurator", "assets/README.md")
 
     # write the actual file
     with open(path, 'r') as f: