Create README.md

README.md

@@ -0,0 +1,52 @@
+---
+license: gpl-3.0
+---
+
+# OpenROAD Chatbot Discussion Dataset
+
+This repo contains useful snippets for discussions. 
+This dataset is gated at July 2024.
+
+## Format
+
+```
+# Topic
+
+Tool: ___
+
+Subcategory: ___
+
+## Conversation
+
+### User1
+...
+
+### User2
+...
+```
+
+## Usage
+
+We refer you to [ORAssistant](https://github.com/The-OpenROAD-Project/ORAssistant), the OpenROAD chatbot
+application aimed to answer user queries for installation and common
+issues. This dataset is used as a data source for the chatbot's retrieval
+augmented generation (RAG) architecture.
+
+## Citing this Work
+
+If you use this software in any published work, we would appreciate a citation!
+Please use the following reference:
+
+```
+@misc{orassistant2024,
+  author = {The-OpenROAD-Project},
+  title = {ORQA Discussions Huggingface Repository},
+  year = {2024},
+  url = {https://huggingface.co/datasets/The-OpenROAD-Project/ORQA_discussions},
+  note = {Accessed: 20xx-xx-xx}
+}
+```
+
+## License
+
+The repository has a GPL3 license.