init

1 files changed, 33 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e53a7f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# VRC OSC stuff
+
+This is a small OSC program I use in VRChat for my chat box.
+This is made for me so its complicated to use.
+
+# Requirements
+
+- linux (I'm not making a windows version)
+- glibc
+- clang
+- [tinyosc](https://github.com/mhroth/tinyosc)
+
+# Installation / Setup
+
+- run ``getreqs.sh`` or download tinyosc and put it in this directory.
+- run ``build.sh`` once or ``cp src/config.def.c src/config.c``.
+- edit ``src/config.c`` to your liking.
+- run ``build.sh``.
+- run ``bin/chatloop``.
+
+Do NOT cd bin then run ``chatloop``. Always have cd in this directory.
+
+Set ``en=1`` in ``src/title.sh`` if you want song titles and artist name to display. Requires playerctl with mpris.
+
+There is also ``bin/type`` to just send text to the chat box.
+
+# To NOT Do
+
+Things I will not make in this. Until I change my mind later.
+
+- PC specs.
+- What app you have open.
+- Local time.