Skip to content

Commit 8f1d572

Browse files
committed
docs: Several minor edits
Remove examples/ dir reference from REDME. It no longer exists. Mention scdoc in installation tutorial. Fix vim joke formatting. Mention systemctl daemon-reload in intallation tutorial.
1 parent 494fd2a commit 8f1d572

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Detailed explaination of what you need to do to get it running can be found
4242

4343
The full documentation is published [here](https://foxcpp.dev/maddy/)
4444

45-
Examples of more advanced configurations with explainations can be found in the
46-
[examples](examples/) directory in the source repository.
45+
Manual pages with reference documentation will be installed by build.sh if
46+
scdoc utility is available on the system.
4747

4848
## Community
4949

docs/tutorials/setting-up.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,19 @@ On Debian-based distributions, this should be enough:
3535
# apt-get install gcc git curl
3636
```
3737

38+
If you want manual pages with reference docs, install scdoc too:
39+
```
40+
# apt-get install scdoc
41+
```
42+
3843
build.sh script will do the rest for you:
3944

4045
```
4146
$ curl 'https://foxcpp.dev/maddy/build.sh' | bash
4247
```
4348

4449
Alternatively, you can download the pre-built tarball from
45-
[GitHub](https://github.com/foxcpp/maddy/releases) and copy its contents into
50+
[GitHub](https://github.com/foxcpp/maddy/releases) and extract its contents into
4651
the root directory.
4752

4853
*Note:* If you can't / don't use this script for some reason, instructions for
@@ -51,7 +56,7 @@ manual installation can be found
5156

5257
## Host name + domain
5358

54-
Open /etc/maddy/maddy.conf with ~~vim~~your favorite editor and change
59+
Open /etc/maddy/maddy.conf with ~~vim~~ your favorite editor and change
5560
the following lines to match your server name and domain you want to handle
5661
mail for.
5762

@@ -89,6 +94,7 @@ renewal. It is possible to force reload via `systemctl reload maddy` (or just
8994
## First run
9095

9196
```
97+
systemctl daemon-reload
9298
systemctl start maddy
9399
```
94100

0 commit comments

Comments
 (0)