mirror of
https://git.sr.ht/~adnano/kiln
synced 2024-12-27 06:16:09 +00:00
Add documentation
This commit is contained in:
parent
99e1906d90
commit
b2aeb6d05d
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1 +1,2 @@
|
||||||
kiln
|
kiln
|
||||||
|
*.1
|
||||||
|
|
22
Makefile
22
Makefile
|
@ -1,16 +1,27 @@
|
||||||
.POSIX:
|
.POSIX:
|
||||||
.SUFFIXES:
|
.SUFFIXES:
|
||||||
|
.SUFFIXES: .1 .1.scd
|
||||||
|
|
||||||
VERSION=0.0.0
|
VERSION=0.0.0
|
||||||
|
|
||||||
PREFIX?=/usr/local
|
PREFIX?=/usr/local
|
||||||
|
MANDIR?=$(PREFIX)/share/man
|
||||||
|
|
||||||
|
VPATH=doc
|
||||||
GO?=go
|
GO?=go
|
||||||
GOFLAGS?=
|
GOFLAGS?=
|
||||||
GOSRC!=find . -name '*.go'
|
GOSRC!=find . -name '*.go'
|
||||||
GOSRC+=go.mod go.sum
|
GOSRC+=go.mod go.sum
|
||||||
|
|
||||||
all: kiln
|
DOCS := \
|
||||||
|
kiln.1
|
||||||
|
|
||||||
|
all: kiln doc
|
||||||
|
|
||||||
|
doc: $(DOCS)
|
||||||
|
|
||||||
|
.1.scd.1:
|
||||||
|
scdoc < $< > $@
|
||||||
|
|
||||||
kiln: $(GOSRC)
|
kiln: $(GOSRC)
|
||||||
$(GO) build $(GOFLAGS) \
|
$(GO) build $(GOFLAGS) \
|
||||||
|
@ -20,13 +31,16 @@ kiln: $(GOSRC)
|
||||||
-o $@
|
-o $@
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f kiln
|
$(RM) kiln
|
||||||
|
$(RM) $(DOCS)
|
||||||
|
|
||||||
install: all
|
install: all
|
||||||
mkdir -p $(DESTDIR)$(PREFIX)/bin
|
mkdir -p $(DESTDIR)$(PREFIX)/bin $(DESTDIR)$(MANDIR)/man1
|
||||||
install -m755 kiln $(DESTDIR)$(PREFIX)/bin
|
install -m755 kiln $(DESTDIR)$(PREFIX)/bin
|
||||||
|
install -m755 kiln.1 $(MANDIR)/man1/kiln.1
|
||||||
|
|
||||||
uninstall:
|
uninstall:
|
||||||
$(RM) $(DESTDIR)$(PREFIX)/bin/kiln
|
$(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
16
README.md
|
@ -12,7 +12,11 @@ A simple static site generator for Gemini.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
First install Go version 1.15 or later.
|
First install the dependencies:
|
||||||
|
|
||||||
|
- Go 1.15 or later
|
||||||
|
- scdoc
|
||||||
|
|
||||||
Then compile:
|
Then compile:
|
||||||
|
|
||||||
$ make
|
$ make
|
||||||
|
@ -20,6 +24,12 @@ Then compile:
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
kiln
|
See kiln(1)
|
||||||
|
|
||||||
For more information, consult the [wiki](https://man.sr.ht/~adnano/kiln/).
|
## 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).
|
||||||
|
|
||||||
|
Subscribe to release announcements on [~adnano/kiln-announce](https://lists.sr.ht/~adnano/kiln-announce).
|
||||||
|
|
Loading…
Reference in a new issue