Browse Source

Add documentation

master
Adnan Maolood 7 months ago
parent
commit
66b93d7299
  1. 1
      .gitignore
  2. 22
      Makefile
  3. 16
      README.md

1
.gitignore

@ -1 +1,2 @@
kiln
*.1

22
Makefile

@ -1,16 +1,27 @@
.POSIX:
.SUFFIXES:
.SUFFIXES: .1 .1.scd
VERSION=0.0.0
PREFIX?=/usr/local
MANDIR?=$(PREFIX)/share/man
VPATH=doc
GO?=go
GOFLAGS?=
GOSRC!=find . -name '*.go'
GOSRC+=go.mod go.sum
all: kiln
DOCS := \
kiln.1
all: kiln doc
doc: $(DOCS)
.1.scd.1:
scdoc < $< > $@
kiln: $(GOSRC)
$(GO) build $(GOFLAGS) \
@ -20,13 +31,16 @@ kiln: $(GOSRC)
-o $@
clean:
rm -f kiln
$(RM) kiln
$(RM) $(DOCS)
install: all
mkdir -p $(DESTDIR)$(PREFIX)/bin
mkdir -p $(DESTDIR)$(PREFIX)/bin $(DESTDIR)$(MANDIR)/man1
install -m755 kiln $(DESTDIR)$(PREFIX)/bin
install -m755 kiln.1 $(MANDIR)/man1/kiln.1
uninstall:
$(RM) $(DESTDIR)$(PREFIX)/bin/kiln
$(RM) $(DESTDIR)$(MANDIR)/man1/kiln.1
.PHONY: all clean install uninstall
.PHONY: all doc clean install uninstall

16
README.md

@ -12,7 +12,11 @@ A simple static site generator for Gemini.
## Installation
First install Go version 1.15 or later.
First install the dependencies:
- Go 1.15 or later
- scdoc
Then compile:
$ make
@ -20,6 +24,12 @@ Then compile:
## Usage
kiln
See kiln(1)
## Contributing
For end-user discussion and questions, start a thread on [~adnano/kiln-discuss](https://lists.sr.ht/~adnano/kiln-discuss).
Send patches to [~adnano/kiln-devel](https://lists.sr.ht/~adnano/kiln-devel).
For more information, consult the [wiki](https://man.sr.ht/~adnano/kiln/).
Subscribe to release announcements on [~adnano/kiln-announce](https://lists.sr.ht/~adnano/kiln-announce).
Loading…
Cancel
Save