From 5e16c6400307d93e90ced300efb3ee4eb76c0524 Mon Sep 17 00:00:00 2001
From: Katharina Fey <kookie@spacekookie.de>
Date: Thu, 23 Jan 2020 22:29:08 +0100
Subject: Adding project documentation and roadmap planning

---
 README | 52 +++++++++++++++++++++++++++++++++++++++++++++++++---
 TODO   | 12 ++++++++++++
 2 files changed, 61 insertions(+), 3 deletions(-)
 create mode 100644 TODO

diff --git a/README b/README
index 71e5eed..03c661f 100644
--- a/README
+++ b/README
@@ -1,4 +1,50 @@
-webgit
-======
+       .'.'
+      .'-'.
+  .  (  o O)
+   \_ `  _,   _
+-.___'.) ( ,-'
+     '-.O.'-..-..       octopus git web frontend
+ ./\/\/ | \_.-._
+        ;
+     ._/
+
+
+A git web frontend that wants to hug your code.
+
+
+Configuration
+-------------
+
+octopus is easy to configure and run, even on systems that don't give
+you priviledged system access.  The main server binary is configured
+primarily with a few environment variables, and an app config.
+
++ OCTOPUS_CONFIG should contain the path of the main configuration
+
++ OCTOPUS_SSL_KEY can optionally be set to the path of a certificate key
+
++ OCTOPUS_SSL_CERT can optionally be set to the path of a certificate
+
+
+The main configuration file is written in yaml, and outlines things
+like the application domain, repo paths, and added modules.  Because
+octopus is vory modular, you can only depend on certain features.
+
+
+---
+app_path: git.octopus.example
+port: 8080
+handle_ssl: false
+cache_path: /var/cache/octopus
+repo_path: /var/lib/octopus/repos
+repo_discovery: false  # Disables automatic config loading from repo_path
+                       # and instead let's you set a static set of repos
+                       # in the section below
+repos:
+  - octopus:
+      description: "🐙 It's a water animal"
+      category: "/"
+  - libkookie:
+      description: "My personal nix expressions"
+      category: "/nix"
 
-The friendly and simple git web interface.
\ No newline at end of file
diff --git a/TODO b/TODO
new file mode 100644
index 0000000..38e8a10
--- /dev/null
+++ b/TODO
@@ -0,0 +1,12 @@
+TODO
+====
+
+Things that need doing for the next milestone/ version.  For now this
+will just be a list of basic features and data that octopus needs
+access to from a repo.
+
+- contributors/ number of contributors
+- commits on $branch for the log
+- Render a README, or markdown README.  Markdown support should be optional
+- Build a lazy abstraction over the repo tree for the explorer
+- 
-- 
cgit v1.2.3