~strahinja/strahinja.srht.site: slw2gmi/index.slw - sourcehut git


                                                                                
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
---
site-name: slw2gmi - slweb to Gemini converter
site-desc: slweb to Gemini converter
stylesheet: /fonts.css
stylesheet: /index.css
canonical: https://strahinja.srht.site/slw2gmi/
meta: index-meta.csv
---
{main}
# slw2gmi

**slw2gmi** is a converter from [**slweb**][slweb] to [Gemini][gemin] format.
Although both are similar to Markdown, the two formats differ enough to warrant
a full converter.  


## Prerequisites

Aside from the obvious (a C compiler, by default **GNU C**), slw2gmi requires
**groff**(1) and **gzip**(1) to create and compress documentation.  **git**(1)
is, aside from cloning the repository, required to use the directive
`{git-log}`.


## Install

```
$ git clone https://git.sr.ht/~strahinja/slw2gmi
$ cd slw2gmi
$ su
```

Then, if you have [apenwarr/redo][aredo]:

```
# redo install
```

if you don't:

```
# ./do install
```

You can specify any compiler which uses `-Wall`, `-c`, `-g` and `-o` like GNU C,
most notably **tcc**(1), by setting the `SLW2GMI_CC` environment variable. For
example:

```
$ SLW2GMI_CC=tcc redo -j10
```

In the case of **tcc**, the tradeoff is that the debug information is limited
compared to **gcc**, but the compilation time is significantly shorter.


## TODO (checklist)

See the file [`TODO`][mtodo] for more information.


## Bugs and limitations

Bugs can be reported using the [ticket tracker][issue]. See the manpage (`man
slw2gmi`) after installing **slw2gmi** for more information.


## License

slw2gmi - slweb to Gemini converter
Copyright (C) 2021 Страхиња Радић

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version. 

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details. 

You should have received a copy of the GNU General Public License along with
this program. If not, see [https://www.gnu.org/licenses/][licen]. 

{git-log}

{made-by}
{/main}

[aredo]: https://github.com/apenwarr/redo
[gemin]: https://gemini.circumlunar.space
[issue]: https://sr.ht/~strahinja/slw2gmi/trackers
[mtodo]: https://git.sr.ht/~strahinja/slw2gmi/tree/master/item/TODO
[katex]: https://katex.org
[licen]: https://www.gnu.org/licenses
[slweb]: https://strahinja.srht.site/slweb/