From 847f5a06299769ccc24f7f2a907c426edcdad633 Mon Sep 17 00:00:00 2001 From: Miguel de la Cruz Date: Fri, 28 Jun 2024 19:35:08 +0200 Subject: [PATCH] Adds the README file with a roadmap --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2591d80 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Gitstatic + +Simple CLI tool to generate webpages from git repositories. + +## Roadmap + +- [ ] Embed templates for the index and repository pages. +- [ ] Generate the index html file for the -index subcommand. +- [ ] Add a proper CLI parsing and subcommands. +- [ ] Add a sample CSS file for the default templates. +- [ ] Add a subcommand to dump the embed templates. +- [ ] Check if the templates exist on a location and use them if + so. Allow to change that location through CLI flags or env vars. +- [ ] Optimize output generation through the use of smaller templates + instead of having all the structs in memory when executing one + template (for large repos). +- [ ] Add an atom feed for the repositories. +- [ ] Add a flag for raw file generation for HEAD. +- [ ] Add a flag for syntax highlighting through Chroma. +- [ ] Add a flag for markdown to HTML. +- [ ] Investigate the viability of generating tarballs for certain + refs.