diff options
| author | Patrick Steinhardt <ps@pks.im> | 2018-03-22 09:20:43 +0000 |
|---|---|---|
| committer | Patrick Steinhardt <ps@pks.im> | 2018-05-30 11:11:07 +0200 |
| commit | 68a3c0b1244687ce07c3d8605e875485d86b05ff (patch) | |
| tree | c20472004015ba6c4fb1702b427c27a33e2dc075 /README.md | |
| parent | 8f96cf9aa55609b3408584d8daa032272203ea2c (diff) | |
| download | libgit2-68a3c0b1244687ce07c3d8605e875485d86b05ff.tar.gz | |
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.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -69,8 +69,8 @@ Quick Start 2. Create the cmake build environment: `cmake ..` 3. Build libgit2: `cmake --build .` -Trouble with these steps? Read `TROUBLESHOOTING.md`. More detailed build -guidance is available below. +Trouble with these steps? Read our (troubleshooting guide)[docs/troubleshooting.md]. +More detailed build guidance is available below. Getting Help ============ @@ -170,12 +170,12 @@ require assistance coordinating this, simply have the worker threads call Threading ========= -See [THREADING](THREADING.md) for information +See [threading](docs/threading.md) for information Conventions =========== -See [CONVENTIONS](CONVENTIONS.md) for an overview of the external +See [conventions](docs/conventions.md) for an overview of the external and internal API/coding conventions we use. Building libgit2 - Using CMake @@ -364,10 +364,10 @@ We welcome new contributors! We have a number of issues marked as and ["easy fix"](https://github.com/libgit2/libgit2/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22easy+fix%22) that are good places to jump in and get started. There's much more detailed -information in our list of [outstanding projects](PROJECTS.md). +information in our list of [outstanding projects](docs/projects.md). -Please be sure to check the [contribution guidelines](CONTRIBUTING.md) to -understand our workflow, and the libgit2 [coding conventions](CONVENTIONS.md). +Please be sure to check the [contribution guidelines](docs/contributing.md) to +understand our workflow, and the libgit2 [coding conventions](docs/conventions.md). License ================================== |