add readme

This commit is contained in:
Preston Baxter 2024-08-17 10:28:28 -05:00
parent 4675429722
commit ef837d584d
1 changed files with 16 additions and 0 deletions

16
Readme.md Normal file
View File

@ -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`