summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMorgana <Morgana@icolotl.com>2026-09-15 11:28:53 -0500
committerMorgana <Morgana@icolotl.com>2026-09-15 11:28:53 -0500
commit2c76015a7a3f3a08ba205b04729f29df9fb7389f (patch)
treee12b09312ab70253d32fb5576f5dd2d76ceda196 /README.md
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3dfb377
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# Index Virtual Terminal
+This is the source code for the Index Virtual Terminal (IVT), a web-based terminal emulator that interfaces with other Index applications enabling their control from a centralized location. In order to run a copy of the IVT, the following additional files are required:
+
+- `data/akasha`, a SQLite3 database with the proper tables for the Index
+- `music/<albums>/<songs>`, a directory containing mp3 music files
+
+To run, host the `static` directory then run `ivt.py`. Next, forward `127.0.0.1:5417` and edit `main.js` to point towards your new websocket location. \ No newline at end of file