Merge pull request #439 from VelocityRa/troubleshooting

Troubleshooting/Common Issues doc
This commit is contained in:
YVT 2016-11-21 20:53:09 +09:00 committed by GitHub
commit fbeff2a26d
2 changed files with 26 additions and 1 deletions

View File

@ -100,7 +100,7 @@ GCC 4.9 / Clang 3.2 or later is recommended because OpenSpades relies on C++11 f
`openspades` or `cd $REPO_DIRECTORY; ./openspades.mk/bin/OpenSpades` and enjoy
### On Windows (with visual studio)
### On Windows (with Visual Studio)
1. Get CMake, Visual Studio 2013 (Express) or Visual Studio 2015 (not very supported), and the OpenSpades source.
Official: https://github.com/yvt/openspades
@ -129,6 +129,9 @@ GCC 4.9 / Clang 3.2 or later is recommended because OpenSpades relies on C++11 f
4. Download [OS X release of OpenSpades](https://github.com/yvt/openspades/releases), show the package contents, and copy `libysrspades.dylib` to the root of OpenSpades source tree.
5. Open `OpenSpades.xcodeproj` and build.
## Troubleshooting
For troubleshooting and common problems see [TROUBLESHOOTING](TROUBLESHOOTING.md).
Licensing
----------------------------------------------------------------------------------------------------
Please see the file named LICENSE.

22
TROUBLESHOOTING.md Normal file
View File

@ -0,0 +1,22 @@
# Troubleshooting
## Check to see if the issue has been reported
***Before* creating an issue, make sure you've searched on the [Issue Tracker](https://github.com/yvt/openspades/issues?utf8=%E2%9C%93&q=is%3Aissue%20) to see if someone else has already reported the same issue**. Use relevant keywords.
## Common Issues
This is a list of commonly encountered problems, known issues, and their solutions.
### Failed to dlload 'libopenal.so'
Make sure libopenal is installed. You shouldn't need to do anything else.
## Create an issue
If your problem hasn't been solved or reported, then create an issue detailing your problem in as much detail as possible.
---
### For more information about OpenSpades, check out the **[Wiki](https://github.com/yvt/openspades/wiki)**.