Browse Source

UpdatedReadme

spesk1 4 years ago
parent
commit
855c66cba2
1 changed files with 10 additions and 0 deletions
  1. 10 0
      README.md

+ 10 - 0
README.md

@@ -10,3 +10,13 @@ Tracking features/TODO's in this README.
 * Diff highlighting for log
 * Line numbers for file browsing
 * README.md markdown renderer/parser / display in project index
+* Figure out way to expose clone/merge/etc interface
+
+## Framework Plans ##
+* gsg -- Perl script to generate the site, uses modules below
+* Shellex.pm -- lib to handle shell calls (can likely split Shellex from simply-git project into it's own repo and maintain it there for both things)
+* GitGather.pm -- module to assemble data structures from git trees that need to be obtained as part of generating the site
+* Html.pm -- probably a bad name, used for writing HTML files and/or editing text in other data structures with html content
+* MdParse.pm -- module for parsing markdown. Likely a fools errand to be writing this myself but I'd like to try
+* GsgConfigParse.pm -- module to parse gsg config, might be overkill to have it's own module
+    * gsg.config -- Config file that gsg reads to inform behavior (git repos dir, what to include/exclude, etc)