nikdoof/grumble
1
0
Fork 0
mirror of https://github.com/nikdoof/grumble.git synced 2025-12-13 08:42:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to README

Browse Source 
Add requirements and Mumble supported version information.
This commit is contained in:
Andrew Williams
2013-11-05 14:09:42 +00:00
parent a04cbb9980
commit 59f437c728
1 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,4 +1,4 @@
grumble Grumble
======= =======
A Small, RESTful API wrapper for Mumble servers. A Small, RESTful API wrapper for Mumble servers.
@@ -8,9 +8,27 @@ The aim is to make a simple Flask based RESTful API to reduce the effort and dev
This application is still under heavy development and it is suggested you do not use it within a production environment. This application is still under heavy development and it is suggested you do not use it within a production environment.
Requirements
------------
Grumble makes use of a few existing libraries and tools to make development:
* Flask
* Flask-RESTful
* MumblePy
All dependencies are covered by either the `setup.py` or `requirements.txt`
Mumble Support
--------------
At the moment Grumble supports the current stable Murmur server, version 1.2.4. This version is required for the ICE Slice file introspection used during connection setup.
Development Environment Development Environment
----------------------- -----------------------
Grumble makes use of Vagrant for its development environment and a simple configuration has been provided to bootstrap a Ubuntu VM running a basic Mumble server. Grumble makes use of Vagrant for its development environment and a simple configuration has been provided to bootstrap a Ubuntu VM running a basic Mumble server.
To initialize the VM run `vagrant up` in the project root directory. To initialize the VM run `vagrant up` in the project root directory.