From 8fc8e889065cb5f28a7f34791233bc4377786b73 Mon Sep 17 00:00:00 2001
From: LinuxMint4Ever <>
Date: Sun, 6 Oct 2019 23:10:51 +0200
Subject: [PATCH] More documentation stuff

---
 README.md                     | 1 +
 devtools/README.md            | 1 +
 lib/README.md                 | 6 ++++++
 lib/jar/README.md             | 2 +-
 lib/launcher/README.md        | 5 +++++
 lib/launcher/java/README.md   | 3 +++
 lib/launcher/python/README.md | 6 ++++--
 res/README.md                 | 3 ++-
 8 files changed, 23 insertions(+), 4 deletions(-)
 create mode 100644 lib/README.md
 create mode 100644 lib/launcher/README.md
 create mode 100644 lib/launcher/java/README.md

diff --git a/README.md b/README.md
index 99a6a8a..f0f77c5 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ The Launcher for my mod pack
 * [ ] Create the launcher backend
 
 # Documentation
+Documentation for each individual file can be found in the same directory
 ## Directories
 * __devtools__ contains development tools
 * __lib__ contains libraries for Minecraft and the launcher
diff --git a/devtools/README.md b/devtools/README.md
index 058330c..e415ba6 100644
--- a/devtools/README.md
+++ b/devtools/README.md
@@ -1,3 +1,4 @@
 # Development tools
+## Files:
 * __fake_java.py__ can be used to get the command used to start Minecraft. When run, it will create a file called `fake_java_out.txt` in its working directory.
 * __rmpyc__ removes all `.pyc` files in the current working directory and all subdirectories.
diff --git a/lib/README.md b/lib/README.md
new file mode 100644
index 0000000..a5652fc
--- /dev/null
+++ b/lib/README.md
@@ -0,0 +1,6 @@
+# lib
+This directory contains libraries, natives and runtimes used by the launcher and Minecraft.
+## Directories
+* __jar__ the libraries for minecraft (and the version jar...)
+* __launcher__ everything used by the launcher
+* __natives__ the natives for minecraft
diff --git a/lib/jar/README.md b/lib/jar/README.md
index 5604ffc..158b5fa 100644
--- a/lib/jar/README.md
+++ b/lib/jar/README.md
@@ -3,5 +3,5 @@
 This directory will contain all libraries Minecraft relies on.
 As Minecraft itself is specified as a library for Forge on the command line, its version jar goes here as well.
 
-Unfortunately, I cannot put them here for convenience due to copyright.
+Unfortunately, I cannot put them here for convenience because of the existence of copyright.
 
diff --git a/lib/launcher/README.md b/lib/launcher/README.md
new file mode 100644
index 0000000..37976d7
--- /dev/null
+++ b/lib/launcher/README.md
@@ -0,0 +1,5 @@
+# lib/launcher
+This directory contains the libraries and runtimes used by the launcher.
+##Directories
+* __java__ the Java components
+* __python__ the python components
diff --git a/lib/launcher/java/README.md b/lib/launcher/java/README.md
new file mode 100644
index 0000000..907804a
--- /dev/null
+++ b/lib/launcher/java/README.md
@@ -0,0 +1,3 @@
+# lib/launcher/java
+##Directories
+* __runtime__ will contain a java runtime
diff --git a/lib/launcher/python/README.md b/lib/launcher/python/README.md
index 29d9ae1..b23649f 100644
--- a/lib/launcher/python/README.md
+++ b/lib/launcher/python/README.md
@@ -1,5 +1,7 @@
 # lib/launcher/python
-
+##Directories:
+* __runtime__ will contain a python runtime
+## Files
 * __gui.py__ will contain the GUI (Wow! Really?). The GUI will be accessed by `main.py`.
 * __mchandler.py__ will be the launcher library. This time, it will not be a runnable hybrid library.
 * __updater.py__ will be used for updating the mod pack and possibly the launcher as well.
@@ -33,7 +35,7 @@
     * [ ] optional launcher updates
     * [ ] optional mod pack updates
     * [ ] setup change updates (used to install/uninstall components)
-  * [ ] add initial mod pack install by applying a setup change update **->** main.py
+  * [ ] add initial mod pack install by applying a setup change update **→** main.py
 * __cfghandler.py__
   * [ ] provide read and write functions for config values
   * [ ] add a function to set the config file path
diff --git a/res/README.md b/res/README.md
index 23cd5d6..caefbe2 100644
--- a/res/README.md
+++ b/res/README.md
@@ -1,4 +1,5 @@
 # res
 This directory will contain the resources used by Minecraft.
 
-__gather_assets.sh__ will conveniently place all your Minecraft assets here for you.
+## Files
+* __gather_assets.sh__ will conveniently place all your Minecraft assets here for you.