mirror of
https://github.com/Ryujinx/libsoundio.git
synced 2024-12-22 23:05:29 +00:00
document dependencies in the readme
This commit is contained in:
parent
efe95ded36
commit
1c8dcfcec5
42
README.md
42
README.md
|
@ -27,7 +27,7 @@ platform is wrong, the next backend is tried.
|
|||
|
||||
## Contributing
|
||||
|
||||
libsoundio is programmed in a tiny subset of C++:
|
||||
libsoundio is programmed in a tiny subset of C++11:
|
||||
|
||||
* No STL.
|
||||
* No `new` or `delete`.
|
||||
|
@ -36,14 +36,25 @@ libsoundio is programmed in a tiny subset of C++:
|
|||
* No references.
|
||||
* No linking against libstdc++.
|
||||
|
||||
Don't get tricked - this is a *C library*, not a C++ library. We just take
|
||||
advantage of a select few C++11 compiler features such as templates, and then
|
||||
link against libc.
|
||||
|
||||
### Building
|
||||
|
||||
Install the dependencies:
|
||||
|
||||
* cmake
|
||||
* ALSA library (optional)
|
||||
* libjack2 (optional)
|
||||
* libpulseaudio (optional)
|
||||
|
||||
```
|
||||
$ mkdir build
|
||||
$ cd build
|
||||
$ cmake ..
|
||||
$ make
|
||||
$ sudo make install
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
||||
### Building With MXE
|
||||
|
@ -53,19 +64,19 @@ You can build libsoundio with [mxe](http://mxe.cc/). Follow the
|
|||
packages necessary on your system. Then somewhere on your file system:
|
||||
|
||||
```
|
||||
$ git clone https://github.com/mxe/mxe
|
||||
$ cd mxe
|
||||
$ make gcc
|
||||
git clone https://github.com/mxe/mxe
|
||||
cd mxe
|
||||
make gcc
|
||||
```
|
||||
|
||||
Then in the libsoundio source directory (replace "/path/to/mxe" with the
|
||||
appropriate path):
|
||||
|
||||
```
|
||||
$ mkdir build-win
|
||||
$ cd build-win
|
||||
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/mxe/usr/i686-w64-mingw32.static/share/cmake/mxe-conf.cmake
|
||||
$ make
|
||||
mkdir build-win
|
||||
cd build-win
|
||||
cmake .. -DCMAKE_TOOLCHAIN_FILE=/path/to/mxe/usr/i686-w64-mingw32.static/share/cmake/mxe-conf.cmake
|
||||
make
|
||||
```
|
||||
|
||||
## Roadmap
|
||||
|
@ -78,6 +89,11 @@ $ make
|
|||
0. ASIO (Windows)
|
||||
0. DirectSound (Windows)
|
||||
0. OSS (BSD)
|
||||
0. list devices example
|
||||
0. sine wave example
|
||||
0. record to playback example
|
||||
0. clean up API and improve documentation
|
||||
0. use a documentation generator and host the docs somewhere
|
||||
|
||||
## Planned Uses for libsoundio
|
||||
|
||||
|
|
12
default.nix
12
default.nix
|
@ -1,12 +0,0 @@
|
|||
with import <nixpkgs> {}; {
|
||||
libsoundioEnv = stdenv.mkDerivation {
|
||||
name = "libsoundio";
|
||||
buildInputs = [
|
||||
alsaLib
|
||||
cmake
|
||||
gcc5
|
||||
libjack2
|
||||
libpulseaudio
|
||||
];
|
||||
};
|
||||
}
|
Loading…
Reference in a new issue