Initial commit HEAD main

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d4bdbf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# shadowbox
+
+git web viewer 
+
+the only real thing i have planned over cgit (with pygments and commonmark filters)
+is rendering images instead of hex dumping them like any other binary
+
+run: `flask --app shadowbox run`
+
+**todo**
+- repo file list
+- filetree
+- individual file previews
+	- syntax highlight code with pygments
+	- render markdown with commonmark
+	- display images
+	- hex dumps for other binaries
+	- link to raw file
+	- file changelog (`git log <filename`)
+	- single file diff with previous version
+- commit page
+	- `git show --patch --compact-summary --diff-algorithm=histogram --abbrev-commit --format="commit %h%d%nprevious %p%nauthored by %aN <%aE> at %cd%ncommitted by %cN <%cE> at %cd%n%n%B"`
+	- and then drive that through pygments or [delta](https://github.com/dandavison/delta)
+- repos with multiple refs (branches, tags, etc.)
+	- diff any two commit-ishes
+- allow incoming `git clone`