Merge pull request #1 from Zambonilli/feature/prototype

Feature/prototype

.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+.vscode
+dist
+node_modules

.vscode/launch.json

@@ -0,0 +1,27 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${file}",
+            "args":[
+                "--modelPath",
+                "<modelPath>",
+                "--inputDir",
+                "<inputDir>",
+                "--outDir",
+                "<outDir>",
+                "--gpuLayers",
+                "<gpuLayers>"
+            ]
+        }
+    ]
+}

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing. At this time, the project is still in it's infancy. So, there's not a lot of structure or guard rails in place for contributions. However, if you have an idea or want to help in any way, please feel free to open an issue, send a message or create a PR against main.

README.md

@@ -1,2 +1,33 @@
 # genai-gamelist
-Use generative AI to create retropie gamelist.xml files.
+genai-gamelist is a Command Line tool for creating retropie gamelist.xml files.
+
+## Local Development
+
+### Setup
+
+1. clone this repo
+2. install nodejs 18.x
+3. npm install
+4. **optional** compile node-llama-cpp for [CUDA](https://withcatai.github.io/node-llama-cpp/guide/CUDA)
+5. download meta's [llama2](https://ai.meta.com/llama/) LLM
+6. convert llama2's to gguf file using [llama-cpp](https://github.com/ggerganov/llama.cpp#prepare-data--run)
+
+### Building
+
+```bash
+npm run format
+npm run build
+```
+
+### Running
+
+```bash
+node dist/index.js \
+    --modelPath <modelPath> \
+    --inputDir <inputDir> \
+    --outDir <outDir>
+```
+
+### Debugging
+
+A vscode debugging file is pushed with this repo. The `Launch Program` profile will launch the cli with default switches and allow you to debug the cli.