summaryrefslogtreecommitdiff
path: root/projects/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'projects/README.md')
-rw-r--r--projects/README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/projects/README.md b/projects/README.md
index 4ee9b0b..21b09f4 100644
--- a/projects/README.md
+++ b/projects/README.md
@@ -1,4 +1,24 @@
-# All projects go in this folder
-# Projects created by create_project.sh
+# Projects
-Each project is a complete ReiLua-Enhanced setup ready to build.
+This folder contains your game projects created with `scripts/create_project.sh`.
+
+Each project is self-contained with:
+- **game/** - Your game code and assets
+- **build/** - Compiled executable
+- **scripts/** - Build and run scripts
+- All necessary ReiLua source files
+
+## Create a New Project
+
+```bash
+cd /path/to/ReiLua-Enhanced
+./scripts/create_project.sh
+```
+
+The script will guide you through setting up:
+- Project name
+- Executable name
+- Author information
+- Version and metadata
+
+Your projects are automatically gitignored in the main repository.