README.md files for Rust projects

Client/ttserverlog/README.md

@@ -0,0 +1,6 @@
+# TeamTalk client example written in C++
+
+This client example asks for log in details and records all conversations to
+.wav files. The example needs to use an administrator account in order to
+record conversations in all channels. In other words the client example
+intercepts voice conversations on the server using the intercept subscription.

Client/ttserverlog_rust/README.md

@@ -0,0 +1,4 @@
+# TeamTalk client example written in Rust
+
+This client uses the **teamtalk_rust** library and works the same as
+**ttserverlog**.

Library/TeamTalk.NET/README.md

@@ -1,7 +1,7 @@
 # .NET managed DLL for TeamTalk DLL
 
 This project contains a .NET DLL with wrappers classes for the C-API
-TeamTalk DLL.
+[TeamTalk DLL](../TeamTalk_DLL).
 
 Use CMake to generate project files and/or build the
 TeamTalk5.NET.dll/TeamTalk5Pro.NET.dll files.
@@ -11,4 +11,4 @@ CMake build options for TeamTalk5.NET:
 * BUILD_TEAMTALK_LIBRARY_DLL_DOTNET
   * Build TeamTalk5.NET.dll for .NET runtime
 * BUILD_TEAMTALK_LIBRARY_DLLPRO_DOTNET
-  * Build TeamTalk5Pro.NET.dll for .NET runtime
+  * Build TeamTalk5Pro.NET.dll for .NET runtime

Library/TeamTalkPy/README.md

@@ -1,6 +1,6 @@
 # Python 3 Interface for TeamTalk DLL
 
-The Python interface for TeamTalk is able to load the TeamTalk DLL
+The Python interface for TeamTalk is able to load the [TeamTalk DLL](../TeamTalk_DLL)
 (shared library) and invoke the functions that are defined in
 *TeamTalk5.py*.
 

Library/TeamTalk_DLL/README.md

@@ -1,13 +1,13 @@
 # TeamTalk C-API header files and libraries
 
-Copy TeamTalk.h (and TeamTalkSrv.h in TeamTalk 5 Professional SDK) to
-this directory along with the libraries. The files are located in the
-`Library/TeamTalk_DLL` folder of the [TeamTalk 5
-SDK](http://bearware.dk/?page_id=419).
-
 TeamTalk.h contains the API for creating a TeamTalk client
 application.
 
 TeamTalkSrv.h contains the API for creating a TeamTalk server
 application. The TeamTalk server API is only available in [TeamTalk 5
 Professional Edition](http://bearware.dk/?page_id=419).
+
+To get the TeamTalk5 and TeamTalk5Pro DLLs (shared libraries) download
+the [TeamTalk 5 SDK](http://bearware.dk/?page_id=419). Alternatively
+manually build [TeamTalkLib](../TeamTalkLib) which will output the DLLs into this
+folder.

Library/teamtalk_rust/README.md

@@ -0,0 +1,7 @@
+# Rust library for TeamTalk DLL
+
+This TeamTalk library for Rust development generates a Rust library using
+[bindgen](https://github.com/rust-lang/rust-bindgen). bindgen simply parses
+[TeamTalk.h](../TeamTalk_DLL/TeamTalk.h) and generates a Rust API for the [TeamTalk DLL](../TeamTalk_DLL).
+
+Use `cargo build` to build the library.

README.md

@@ -52,6 +52,8 @@ Projects wrapping the client and server binaries in the TeamTalk SDK.
     * Preliminary API [Documentation](https://bearware.dk/teamtalksdk/v5.12a/docs/Java/)
 * [**TeamTalkPy**](Library/TeamTalkPy) (dependency: **TeamTalk_DLL**)
   * Python wrappers for TeamTalk DLL
+* [**teamtalk_rust**](Library/teamtalk_rust) (dependency: **TeamTalk_DLL**)
+  * Rust library for TeamTalk DLL generated by [bindgen](https://github.com/rust-lang/rust-bindgen)
 
 ## TeamTalk 5 Clients
 Projects containing client applications which use the TeamTalk 5 client DLL.
@@ -84,6 +86,8 @@ Projects containing client applications which use the TeamTalk 5 client DLL.
         * Located in `Library/TeamTalkJNI/libs/[armeabi-v7a|arm64-v8a|x86|x86_64]` (Professional Edition)
 * [**ttserverlogpy**](Client/ttserverlogpy) (dependency: **TeamTalkPy**
   * Python example client
+* [**ttserverlog_rust**](Client/ttserverlog_rust) (dependency: **teamtalk_rust**)
+  * Rust example client
 * [**ttphpadmin**](Client/ttphpadmin)
   * Console PHP-script for administrating a TeamTalk 5 server.
   * Run `php ttphpadmin.php`