From 18b11d2a32323f52d5a86a0bea628373d5744ecb Mon Sep 17 00:00:00 2001 From: meeh Date: Tue, 24 Apr 2018 00:48:08 +0000 Subject: [PATCH] Reducing the amount of "items" in the root of the repo by moving documents into a own docs directory. --- README.md | 2 +- README.DIRECTORIES.md => docs/DIRECTORIES.md | 0 README.HACKING.md => docs/HACKING.md | 6 +++--- README.MONOTONECHEATSHEET.md => docs/MONOTONECHEATSHEET.md | 0 4 files changed, 4 insertions(+), 4 deletions(-) rename README.DIRECTORIES.md => docs/DIRECTORIES.md (100%) rename README.HACKING.md => docs/HACKING.md (88%) rename README.MONOTONECHEATSHEET.md => docs/MONOTONECHEATSHEET.md (100%) diff --git a/README.md b/README.md index a62397d57..6eae9e825 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ or run 'ant javadoc' then start at build/javadoc/index.html ## How to contribute / Hack on I2P -Please check out [README.HACKING.md](README.HACKING.md) +Please check out [HACKING.md](docs/HACKING.md) and other documents in the docs directory. ## Building packages from source diff --git a/README.DIRECTORIES.md b/docs/DIRECTORIES.md similarity index 100% rename from README.DIRECTORIES.md rename to docs/DIRECTORIES.md diff --git a/README.HACKING.md b/docs/HACKING.md similarity index 88% rename from README.HACKING.md rename to docs/HACKING.md index 02460d285..c16cf1a4d 100644 --- a/README.HACKING.md +++ b/docs/HACKING.md @@ -18,7 +18,7 @@ of Gradle and SBT in the end when we know what kind of structure we want. If you're new at this, which we all was at one point, I'll have some tips. -* Check out our [README.DIRECTORIES.md](README.DIRECTORIES.md) to learn ore +* Check out our [DIRECTORIES.md](DIRECTORIES.md) to learn ore about where you'll find I2P's different parts in the codebase. * For me (Meeh), it worked well to run `find . -type f -name '*Runner.java'` @@ -28,10 +28,10 @@ of hints of how this is peaced together lies there. ## The .. Monotone part -Check out [README.MONOTONECHEATSHEET.md](README.MONOTONECHEATSHEET.md) file. +Check out [MONOTONECHEATSHEET.md](MONOTONECHEATSHEET.md) file. ## SBT Behind proxy Seems it's a hassle behind SOCKSv5. But for use of HTTP proxy to fetch dependencies and such, please edit `export SBT_OPTS="$SBT_OPTS -Dhttp.proxyHost=myproxy-Dhttp.proxyPort=myport"` -to have correct values for your system, then execute it before you start SBT. \ No newline at end of file +to have correct values for your system, then execute it before you start SBT. diff --git a/README.MONOTONECHEATSHEET.md b/docs/MONOTONECHEATSHEET.md similarity index 100% rename from README.MONOTONECHEATSHEET.md rename to docs/MONOTONECHEATSHEET.md