From 99efd89abc49de5c8a4738a4e88272e04f20f44e Mon Sep 17 00:00:00 2001
From: Overlord <overlordontwitch@gmail.com>
Date: Tue, 17 Feb 2026 23:26:42 +0100
Subject: [PATCH] updated .gitignore, added rust project init, updated README

---
 .gitignore  | 18 +++--------
 Cargo.toml  |  6 ++++
 README.md   | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 src/main.rs |  4 +++
 4 files changed, 103 insertions(+), 13 deletions(-)
 create mode 100644 Cargo.toml
 create mode 100644 src/main.rs

diff --git a/.gitignore b/.gitignore
index 0b188bc..29455a4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,18 +1,10 @@
-# ---> Rust
-# Generated by Cargo
-# will have compiled files and executables
+.idea/
+.vscode/
+
 debug/
 target/
 
-# These are backup files generated by rustfmt
-**/*.rs.bk
+Cargo.lock
 
-# MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
-
-# RustRover
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+**/*.rs.bk
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..2266b7f
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,6 @@
+[package]
+name = "new_vegas_radio"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
diff --git a/README.md b/README.md
index cc4e7dd..3bec7bc 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,90 @@
 # NewVegasRadio
 
+---
+
+### Assets-Directory Structure:
+
+```terminaloutput
+assets/
+    config.(json|toml)
+    songs/
+        my_song/
+            my_song.mp3
+            descriptor.(json|toml)
+            intro/
+                MrNewVegas_N.mp3 (optional)
+            outro/
+                MrNewVegas_N.mp3 (optional)
+    generic/
+        MrNewVegas_N.mp3
+```
+
+---
+
+#### `config.json`:
+```json5
+{
+  "defaults": {
+    "songs_directory":   "songs",
+    "generic_directory": "generic",
+    "log_directory":     "logs",
+    "temp_directory":    "temp"
+  },
+  "settings": {
+    "weight":    1.0,
+    "volume":    1.0,
+    "crossfade": 2.0 // in seconds
+  },
+  "rules": {
+    "shuffle_mode": "weighted", // options: "weighted", "strict_random"
+    "max_same_genre_in_row": 2
+  }
+}
+
+```
+OR
+#### `config.toml`:
+```toml
+[defaults]
+songs_directory   = "songs"
+generic_directory = "generic"
+log_directory     = "logs"
+temp_directory    = "temp"
+
+[settings]
+weight    = 1.0
+volume    = 1.0
+crossfade = 2.0 # in seconds
+
+[rules]
+shuffle_mode          = "weighted" # "weighted", "strict_random"
+max_same_genre_in_row = 2
+```
+
+---
+
+#### `descriptor.json`:
+```json5
+{
+  "title":  "[I Got Spurs That] Jingle, Jangle, Jingle",
+  "artist": "Kay Kyser",
+  "tags":   ["orchestra", "swing", "jazz"],
+  "genre":  ["swing", "jazz"],
+  "intro":  false,
+  "outro":  false,
+  "weight": 1.0, // optional
+  "volume": 1.0, // optional
+}
+```
+OR
+#### `descriptor.toml`:
+```toml
+title  = "[I Got Spurs That] Jingle, Jangle, Jingle"
+artist = "Kay Kyser"
+tags   = ["orchestra", "swing", "jazz"]
+genre  = ["swing", "jazz"]
+intro  = false
+outro  = false
+weight = 1.0 # optional
+volume = 1.0 # optional
+```
diff --git a/src/main.rs b/src/main.rs
new file mode 100644
index 0000000..3033f62
--- /dev/null
+++ b/src/main.rs
@@ -0,0 +1,4 @@
+
+fn main() {
+
+}