From ef837d584d8e0330fb5483d5dde69507e460c005 Mon Sep 17 00:00:00 2001
From: Preston Baxter <preston@preston-baxter.com>
Date: Sat, 17 Aug 2024 10:28:28 -0500
Subject: [PATCH] add readme

---
 Readme.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..ad52e7a
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,16 @@
+# mod_skel_rs
+
+The goal of this project is to provide a way for rust to be used in the course of freeswitch plugin development
+
+## Building
+
+The `build.rs` attempts to link against the system `<switch.h` and `libfreeswitch.so`.
+Make sure `libfreeswitch-dev` is installed on debian based systems
+Or `freeswitch-devel` is installed for RHEL based systems
+
+Most likely though none of those packages exist and you need to build freeswitch from source and run `make install`
+
+Once freeswitch is installed on your system you can then run
+
+`cargo build --release`
+