aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristopher Brannon <chris@the-brannons.com>2021-03-31 12:49:30 -0700
committerChristopher Brannon <chris@the-brannons.com>2021-03-31 12:49:30 -0700
commitf94268c0678c5d3ad21b7b7656eaaf3a48d58d6b (patch)
treeed06de2f38d7d0f9fdaf2aedcb2d74a58750397e
parent231715bd2cd7328e3649de532d340565e8bcc216 (diff)
downloadnawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.tar
nawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.tar.gz
nawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.tar.bz2
nawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.tar.lz
nawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.tar.xz
nawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.tar.zst
nawp-f94268c0678c5d3ad21b7b7656eaaf3a48d58d6b.zip
Add headings and a note about clone URLs to README.
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2bb6c99..2272208 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ to work just now.
NAWP stores content in an sqlite database. It is dynamic, not a static
site generator. It is supposed to run as a CGI script.
+## Installing
+
Here is a list of the external Scheme libraries ("eggs" in Chicken Scheme parlance) that NAWP needs:
* anaphora
@@ -59,6 +61,8 @@ Here's a sample configuration snippet for lighttpd:
cgi.assign = ( "" => "" )
}
+## Using
+
To make a post, visit https://yourdomain/blog/post-form and fill in the fields.
Just visiting https://yourdomain/blog will show the most recent posts.
@@ -71,6 +75,14 @@ starting with `patch_`. I borrowed this idea from Tim Vaughan, author
of `elpher` et al. The difference is that Tim Vaughan uses the `git://`
protocol, where I use `https://`.
+Note that you need to be using the canonical clone URL to push:
+`https://the-brannons.com/git/nawp`
+
+I forgot to disable cgit's "dumb HTTP clone endpoint" feature, so if you
+cloned with a `/cgit` URL and want to contribute, you should do
+
+ git remote set-url origin 'https://the-brannons.com/git/nawp'
+
## Roadmap
I plan on adding an API. It will probably be the metaweblog XML-RPC