commit
message
Docs, make install + deps, better links for dev config
author
Ben Vogt <[email protected]>
date
2023-04-05 19:15:32
stats
3 file(s) changed,
30 insertions(+),
9 deletions(-)
files
Makefile
README.md
dev-config-gshr.toml
1diff --git a/Makefile b/Makefile
2index ae3d344..86b8914 100644
3--- a/Makefile
4+++ b/Makefile
5@@ -13,9 +13,15 @@ target/output: target
6 clean:
7 rm -rf target/*
8
9+deps:
10+ go mod download
11+
12 fmt:
13 go fmt
14
15+install:
16+ go install
17+
18 target/gshr.bin: Makefile target $(wildcard *.go)
19 go build -o target/gshr.bin $(wildcard *.go)
20
21diff --git a/README.md b/README.md
22index 8fbd3ec..545e355 100644
23--- a/README.md
24+++ b/README.md
25@@ -30,7 +30,7 @@ cd target/output
26 python3 -m http.server 80
27 ```
28
29-See more examples in [tree/master/examples](tree/master/examples).
30+See example TOML configs in root directory.
31
32 ---
33
34@@ -54,6 +54,20 @@ The toml file needs to be in the format:
35 * `published_git_url`: Optional Link to where the repo lives. Eg: `github.com/vogtb/gshr`.
36 * `host_git`: Bool of whether we should package the repo up into `{name}.git` and host it.
37
38+For example:
39+
40+```toml
41+base_url = "http://localhost/"
42+site_name = "public, self hosted git repositories"
43+
44+[[repos]]
45+name = "gshr"
46+description = "git static host repo -- generates static html for repos"
47+url = "https://github.com/vogtb/gshr"
48+published_git_url = "https://github.com/vogtb/gshr"
49+host_git = true
50+```
51+
52 ---
53
54 ## Output
55diff --git a/dev-config-gshr.toml b/dev-config-gshr.toml
56index 3b52a0f..e03bcc4 100644
57--- a/dev-config-gshr.toml
58+++ b/dev-config-gshr.toml
59@@ -1,23 +1,23 @@
60-base_url = "http://localhost/"
61+base_url = "http://localhost/git/"
62 site_name = "public, self hosted git repositories"
63
64 [[repos]]
65 name = "gshr"
66 description = "git static host repo -- generates static html for repos"
67-url = "/Users/bvogt/dev/src/ben/gshr"
68+url = "https://github.com/vogtb/gshr"
69 published_git_url = "github.com/vogtb/gshr"
70 host_git = true
71
72-[[repos]]
73-name = "www"
74-description = "static site for www.vogt.world"
75-url = "/Users/bvogt/dev/src/ben/www"
76-published_git_url = "github.com/vogtb/www"
77-host_git = true
78-
79 [[repos]]
80 name = "f7"
81 description = "f7 is a spreadsheet formula execution library"
82-url = "/Users/bvogt/dev/src/ben/f7"
83+url = "https://github.com/vogtb/f7"
84 published_git_url = "github.com/vogtb/f7"
85 host_git = true
86+
87+[[repos]]
88+name = "spreadsheet"
89+description = "TypeScript/javascript spreadsheet parser, with formulas."
90+url = "https://github.com/vogtb/spreadsheet"
91+published_git_url = "github.com/vogtb/spreadsheet"
92+host_git = true