1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# comitium
comitium is a [Gemini][], Gopher, and HTTP feed aggregator that supports Atom,
RSS, JSON, and [Gemini feeds][], as well as tracking page changes, which is
output into a simple static Gemini document that you can put anywhere.
*Comitium* means “gathering” or “assembly” in Latin.
[Gemini]: https://gemini.circumlunar.space/docs/faq.gmi
[Gemini feeds]: https://gemini.circumlunar.space/docs/companion/subscription.gmi
[lagrange]: https://github.com/skyjake/lagrange/blob/dev/res/about/help.gmi#L184-L197
[gmisub]: https://git.sr.ht/~callum/gmisub
[gemreader]: https://sr.ht/~sircmpwn/gemreader/
## why another aggregator?
There are many Gemini aggregators out there, and yet not one does everything I
want it to. I want an aggregator that:
1. Works with Gemini and Gopher (and possibly http)
2. Supports Atom, RSS, and Gemini feeds (and possibly JSON feeds)
3. Can watch a page for changes
4. Simple usage that doesn't get all tangled with my bookmarks
(\*cough\**Lagrange*\*cough\*)
All of the aggregators always have really cool and unique features, and yet all
that I've found don't meet one or more of these basic (IMO) criterion. Hence,
going and writing my own.
Also, it's nice if it doesn't tie me to a specific browser/service; i.e.
trivially self-hostable, ideally as CGI or static pages that can use an existing
server setup.
## usage
See `comitium help` for basic usage. For more detailed usage, see
[comitium(1)][comitium.1].
To get up and running, see the [quickstart page][quickstart].
[comitium.1]: doc/comitium.1.scd
[quickstart]: doc/quickstart.md
## building
Dependencies:
* go (module-aware)
* [scdoc][]
Then do the standard:
```
$ make
# make install
```
A note to packagers (yes, I'm ambitious aren't I?): make sure to build with
`make COMMIT=tarball`, otherwise there will be an issue when building in a
non–git-repo.
[scdoc]: https://git.sr.ht/~sircmpwn/scdoc
## contributing
Send patches and issue reports to
[~nytpu/public-inbox@lists.sr.ht][mailto:~nytpu/public-inbox@lists.sr.ht]
## attributions
`comitium` took inspiration and small code snippets from:
* [Amfora][] — how to structure saving subscriptions to JSON and refreshing
subscriptions with goroutines.
* [gemreader][] — simple Gemini feed parsing.
`comitium` gratefully makes use of the following libre libraries:
* [go-gemini][] for fetching Gemini resources.
* [go-gopher][] for fetching Gopher resources.
* [gofeed][] for parsing Atom, RSS, and JSON feeds.
* [pflag][] for parsing flags and arguments.
* [go-homedir][] for locating configuration directories.
[Amfora]: https://github.com/makeworld-the-better-one/amfora
[gemreader]: https://git.sr.ht/~sircmpwn/gemreader
[go-gemini]: https://git.sr.ht/~adnano/go-gemini
[go-gopher]: https://github.com/prologic/go-gopher
[gofeed]: https://github.com/mmcdole/gofeed
[pflag]: https://github.com/spf13/pflag
[go-homedir]: https://github.com/mitchellh/go-homedir
## license
`comitium` is Copyright © 2021 nytpu.
`comitium` is licensed under the terms of the GNU Affero General Public
License, either version 3 of the License, or (at your option) any later
version. For more information, see [LICENSE][] or the [GNU website][agpl-3]
[LICENSE]: LICENSE
[agpl-3]: https://www.gnu.org/licenses/agpl-3.0-standalone.html
|
