aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorChris Robinson <[email protected]>2009-12-07 01:05:01 -0800
committerChris Robinson <[email protected]>2009-12-07 01:05:01 -0800
commit88f3d747b7af1322e19a01e56e466992bfe226bf (patch)
tree5643a87905c1d6362842c3efb2f388064303d2ca /README
parentd4427c54eaf07d87ad2b056ac6b46ce20e5ad2f3 (diff)
Add a simple README
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..0ff4dc33
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+Source Install
+==============
+
+To install OpenAL Soft, use your favorite shell to go into the build/
+directory, and run:
+
+cmake ..
+
+Assuming configuration went well, you can then build it, typically using GNU
+Make (KDevelop, MSVC, and others are possible depending on your system setup
+and CMake configuration).
+
+Please Note: Double check that the appropriate backends were detected. Often,
+complaints of no sound, crashing, and missing devices can be solved by making
+sure the correct backends are being used. CMake's output will identify which
+backends were enabled.
+
+For most systems, you will likely want to make sure ALSA, OSS, and PulseAudio
+were detected (if your target system uses them). For Windows, make sure
+DirectSound was detected.