commit 9ae4502b20e495b47432cec4357ed1915a7c1f4c
Author: David Voznyarskiy <davidv@no-reply@disroot.org>
Date: Fri Apr 3 22:13:59 2026 -0700
major edits are done, small optimizations and completing TODOs are now left
Signed-off-by: David Voznyarskiy <davidv@no-reply@disroot.org>
diff --git a/README b/README
deleted file mode 100644
index c49e398..0000000
--- a/README
+++ /dev/null
@@ -1,50 +0,0 @@
-Shroomgit: shindex shgit
-========================
-Quickly generate a static html page of your git repos
-
-
-Requirements
-------------
-git
-go
-
-
-Installation
-------------
-
- git clone https://git.disroot.org/davidv/shroomgit.git
- cd shroomgit
- make
-
-The shindex and shgit binaries will be within the bin/ directory
-
-
-Documentation
--------------
-1) shindex: generate an index page of various repositories
-
- shindex repo1 repo2 ... > site.html
-
-Shindex directory outputs HTML code, use that to direct it to where you
-want. Shindex works with an unlimited amount of repositories as input.
-
-Within shared/shared.go, the logo, the page title, and description can
-be configured and edited.
-
-2) shgit: generate pages for a repository
-
- shgit repo output_dir
- shgit repo
-
-Still very much a work in progress. Shgit takes a repository as an
-argument and outputs multiple HTML files and directories into either a
-specified directory or, if no output directory is given, into the
-working directory.
-
-Within shared/shared.go, configuration of the logo and favicon can be
-set.
-
-
-License
--------
-unlicense license <https://unlicense.org/>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b746c28
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+Shroomgit: shindex shgit
+========================
+Generate a static html page of your git repos
+
+
+Requirements
+------------
+git
+go
+
+
+Installation
+------------
+
+ git clone https://git.disroot.org/davidv/shroomgit.git
+ cd shroomgit
+ make
+
+The shindex and shgit binaries will be within the bin/ directory
+
+
+Documentation
+=============
+
+shindex
+-------
+generate an index page of various repositories
+
+ shindex repo1 repo2 ... > site.html
+
+Shindex directory outputs HTML code, use that to direct it to where you
+want. Shindex works with an unlimited amount of repositories as input.
+
+Within shindex/config.go, the logo, the page title, and description can
+be configured and edited.
+
+* title: name of the HTML page
+* logo: path to the image
+* logoHref: redirection after clicking logo
+* logoWidth, LogoHeight: size customization for logo
+* desc: writes a description at top of page
+
+
+shgit
+-----
+generate pages for a repository
+
+ shgit repo output_dir
+ shgit repo
+
+Still very much a work in progress. Shgit takes a repository as an
+argument and outputs multiple HTML files and directories into either a
+specified directory or, if no output directory is given, into the
+working directory.
+
+Within shgit/config.go configuration of the logo and favicon as well
+as some HTML elements can be set.
+
+Shgit Config:
+
+* favicon: path to the image
+* logo: path to the image
+* logoHref: redirection after clicking logo
+* logoWidth, LogoHeight: size customization for logo
+* url: assumes the URL and repo name is the git clone location
+
+The map style is configured by default to control how lines of
+code and text are displayed on many pages. Further customization of
+HTML elements can be altered in the files within the shgit directory.
+
+
+License
+-------
+unlicense license <https://unlicense.org/>
diff --git a/shindex/shindex.go b/shindex/shindex.go
index 5c20994..ca8effd 100644
--- a/shindex/shindex.go
+++ b/shindex/shindex.go
@@ -160,4 +160,3 @@ func printHelp(errorNum int) {
fmt.Println("Usage: shindex [repo_path...]")
fmt.Println("creates a static html page to display git repos")
}
-
