summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2016-08-17 12:44:32 -0400
committerJordan Wiens <jordan@psifertex.com>2016-08-17 12:44:32 -0400
commit04ac36833afc8a2882aaadfe7864ebf3e416a178 (patch)
treea1e05a160848497c6acb862b663527c04c591199
parent5f444e5444cec4ff3f270e1ced16b60f00f57f9e (diff)
minor docs update with troubleshooting section
-rw-r--r--docs/getting-started.md12
-rw-r--r--docs/guide/troubleshooting.md29
-rw-r--r--mkdocs.yml4
3 files changed, 32 insertions, 13 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 9b65c8ab..b2a82131 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -156,18 +156,8 @@ On windows, this is achieved through a separate launcher that loads first and re
Most preferences are fairly intuitive. There is no advanced preference system at this time, but it is [expected](https://github.com/Vector35/binaryninja-api/issues/126) to be added soon.
-## Troubleshooting
-
-### Common problems
-
-- If you are having problems finding your license or the installers, you can always [recover] either with a self-service email mechanism.
-- If experiencing problems with Windows UAC permissions during an update, the easiest fix is to completely un-install and re-download the latest installer. Preferences are saved outside the installation folder and are preserved.
-- Always check both closed and open [issues](https://github.com/Vector35/binaryninja-api/issues) on the github issues search.
-
-### Getting Support
+## Getting Support
Vector 35 offers a number of ways to get Binary Ninja [support].
-[recover]: https://binary.ninja/recover.html
[support]: https://binary.ninja/support.html
-[issues]: https://github.com/Vector35/binaryninja-api/issues
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
index e69de29b..1d64b57b 100644
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@ -0,0 +1,29 @@
+# Troubleshooting
+
+## Basics
+
+ - Have you searched [known issues]?
+ - Is your computer powered on?
+ - Did you read all the items on this page?
+ - Then you should contact [support]!
+
+### License Trouble
+
+- If experiencing problems with Windows UAC permissions during an update, the easiest fix is to completely un-install and re-download the latest installer. Preferences are saved outside the installation folder and are preserved, though you might want to remove your [license](/getting-started/index.html#license).
+
+## Arch Linux
+
+Arch Linux is not an officially supported operating system, but many of our users have run it, and there are a few pitfalls to watch out for.
+
+ - Install python2 from the [official repositories][archrepo]
+ - Install the [libcurl-compat] library from AUR, and run Binary Ninja via `LD_PRELOAD=libcurl.so.3 ~/binaryninja/binaryninja`
+
+## API
+
+ - If the GUI launches but the license file is not valid, check that you're using the right version of Python. Only a 64-bit Python 2.7 is supported at this time.
+
+[known issues]: https://github.com/steakknife/unsign
+[libcurl-compat]: https://aur.archlinux.org/packages/libcurl-compat/
+[archrepo]: https://wiki.archlinux.org/index.php/Official_repositories
+[recover]: https://binary.ninja/recover.html
+[support]: https://binary.ninja/support.html
diff --git a/mkdocs.yml b/mkdocs.yml
index cfa1689d..1040aa75 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -20,7 +20,7 @@ markdown_extensions:
pages:
- Home: 'index.md'
- Getting Started Guide: 'getting-started.md'
- #- User Guide:
+ - User Guide:
#- Installing: 'guide/installing.md'
#- Running: 'guide/running.md'
#- Interface: 'guide/interface.md'
@@ -28,7 +28,7 @@ pages:
#- SCC: 'guide/scc.md'
#- Types Library: 'guide/type.md'
#- Using Plugins: 'guide/plugins.md'
- #- Troubleshooting: 'guide/troubleshooting.md'
+ - Troubleshooting: 'guide/troubleshooting.md'
- Developer Guide:
- Contributing Documentation: 'dev/documentation.md'
#- Plugin Design: 'dev/plugins.md'