Merge branch 'master' of https://github.com/corrados/jamulus
This commit is contained in:
commit
8f4684878b
3 changed files with 9 additions and 83 deletions
58
INSTALL.md
58
INSTALL.md
|
@ -1,57 +1,11 @@
|
|||
Jamulus Compile Instructions
|
||||
|
||||
Installing Jamulus
|
||||
============================
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Rquired software: QT, a compiler like Visual Studio, ASIO development files
|
||||
|
||||
- copy ASIO development files in llcon/windows directory so that, e.g., the
|
||||
directory llcon/windows/ASIOSDK2/common exists
|
||||
- open Jamulus.pro in Qt Creator and compile & run
|
||||
[Please see this overview](https://github.com/corrados/jamulus/wiki/Software-Manual) containing instructions for installing and using Jamulus for your platform.
|
||||
|
||||
|
||||
Linux
|
||||
-----
|
||||
Compiling Jamulus
|
||||
============================
|
||||
|
||||
Required packages:
|
||||
|
||||
- Build-Essential
|
||||
- Qt4/Qt5 (devel packages, too!)
|
||||
- Jack (devel packages, too!)
|
||||
- qjackctl can be a good help configure jack.
|
||||
|
||||
On the most common Linux distributions, the following command should prepare the system for compilation:
|
||||
|
||||
sudo apt-get install build-essential libqt4-dev libjack-jackd2-dev
|
||||
|
||||
On Fedora use:
|
||||
|
||||
sudo dnf install jack-audio-connection-kit-dbus jack-audio-connection-kit-devel qt5-qtdeclarative-devel
|
||||
|
||||
~~~
|
||||
qmake Jamulus.pro
|
||||
make clean
|
||||
make
|
||||
~~~
|
||||
|
||||
Run the application with `$ ./Jamulus`
|
||||
|
||||
Note that the "make clean" is essential to remove the automatically generated Qt files which are present in the .tar.gz file and may not match the Qt version you are using.
|
||||
|
||||
To use an external shared OPUS library instead of the built-in use qmake `"CONFIG+=opus_shared_lib" Jamulus.pro`.
|
||||
|
||||
To use this file configure the software with `qmake "CONFIG+=noupcasename" Jamulus.pro` to make sure the output target name of this software is jamulus instead of Jamulus.
|
||||
|
||||
Jamulus is also compatible with Qt5.
|
||||
|
||||
To configure and run Jamulus as a server, see the [server documentation](https://github.com/corrados/jamulus/wiki/Running-a-Server).
|
||||
|
||||
|
||||
Mac
|
||||
---
|
||||
|
||||
Download and install Apple Xcode and QT SDK for Mac.
|
||||
|
||||
- qmake Jamulus.pro
|
||||
- open Jamulus.xcodeproj and compile & run
|
||||
[Please see these instructions](https://github.com/corrados/jamulus/wiki/Compiling)
|
||||
|
|
|
@ -23,7 +23,7 @@ The project is hosted at [Sourceforge.net](http://sourceforge.net/projects/llcon
|
|||
Required Hardware Setup
|
||||
-----------------------
|
||||
|
||||
The required minimum internet connection speed is 200 kbps for the up- and downstream.
|
||||
The required minimum internet connection speed is 200 kbps (0.2Mbps) for the up and down-stream.
|
||||
The ping time (i.e. round trip delay) from your computer to the server should not exceed 40 ms average.
|
||||
|
||||
For the Jamulus software to run stable it is recommended to use a PC with at least 1.5 GHz CPU frequency.
|
||||
|
@ -54,10 +54,9 @@ Bugs and feature requests can be [reported here](https://github.com/corrados/jam
|
|||
Compilation and Development
|
||||
---------------------------
|
||||
|
||||
See the these [compile Instructions](INSTALL.md)
|
||||
See the [compile Instructions](INSTALL.md)
|
||||
|
||||
For server instructions, see [server manual](src/res/homepage/servermanual.md)
|
||||
and the [server documentation](https://github.com/corrados/jamulus/wiki/Running-a-Server).
|
||||
For setting up and running a server, see [this guide](https://github.com/corrados/jamulus/wiki/Running-a-Server)
|
||||
|
||||
|
||||
Acknowledgments
|
||||
|
|
|
@ -1,27 +0,0 @@
|
|||
Server Manual
|
||||
============================
|
||||
|
||||
### Jamulus server requirements
|
||||
|
||||
The minimum internet connection speed for the server is 1 Mbps for up- and downstream and a very low ping time.
|
||||
It is recommended to have at least 1.6 GHz CPU frequency and 1 GB RAM.
|
||||
The Jamulus server can be run on all supported operating systems (Windows, MacOS and Linux).
|
||||
|
||||
### Using Windows OS
|
||||
|
||||
After installing Jamulus you find a link to the server in the Windows start menu (or "All apps" under Windows 8).
|
||||
When starting the server it automatically registers at the official central server. Just type in the name,
|
||||
city and country so that other users can easily identify your server.
|
||||
|
||||
If you want the server to be started automatically on each Windows start, enable the corresponding check box.
|
||||
If you do not want to register your server at the official central server (so that it does not show up in the
|
||||
server list of jamulus.dyndns.org) uncheck the "Register" check box.
|
||||
|
||||
### Using a Linux shell
|
||||
|
||||
If the server shall be started from within an ssh shell, there is a command line option
|
||||
|
||||
`./Jamulus -s -n`
|
||||
|
||||
available which starts the server without a GUI (even though the GUI is not used, QT must still be installed on the
|
||||
server to run the Jamulus server software).
|
Loading…
Reference in a new issue