docs: reorganize documents

Our non-technical documents are currently floating around loosely in our
project's root, making it harden than necessary to discover what one is
searching for. We do have a "docs/" directory, though, which serves
exactly that purpose of hosting documentation.

Move our non-technical documentation into the "docs/" directory. Adjust
all links to these documents.
This commit is contained in:
Patrick Steinhardt
2018-03-22 09:20:43 +00:00
parent 8f96cf9aa5
commit 68a3c0b124
9 changed files with 16 additions and 18 deletions

13
docs/troubleshooting.md Normal file
View File

@@ -0,0 +1,13 @@
Troubleshooting libgit2 Problems
================================
CMake Failures
--------------
* **`Asked for OpenSSL TLS backend, but it wasn't found`**
CMake cannot find your SSL/TLS libraries. By default, libgit2 always
builds with HTTPS support, and you are encouraged to install the
OpenSSL libraries for your system (eg, `apt-get install libssl-dev`).
For development, if you simply want to disable HTTPS support entirely,
pass the `-DUSE_HTTPS=OFF` argument to `cmake` when configuring it.