From: Thibault Godouet <yo8192@users.noreply.github.com>
Date: Thu, 31 Aug 2023 12:30:55 +0000 (+0100)
Subject: Explain how to build the documentation in the README.
X-Git-Tag: ver3_3_2~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0e9217a3454b4197379165d0b1087a965b55e1f0;p=thirdparty%2Ffcron.git

Explain how to build the documentation in the README.
---

diff --git a/README b/README
deleted file mode 100644
index d502111..0000000
--- a/README
+++ /dev/null
@@ -1,2 +0,0 @@
-See readme.txt in directory doc/en/txt/
- or readme.html in directory doc/en/HTML/.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd235ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+See http://fcron.free.fr/ and http://fcron.free.fr/doc/en/.
+
+Alternatively, if you downloaded fcron as a tarball, see:
+* readme.txt in directory doc/en/txt/
+* or readme.html in directory doc/en/HTML/.
+
+If you cloned the git repo, you first need to build the documentation.
+On a Debian based system:
+```
+$ sudo apt install -y docbook docbook-xsl docbook-xml docbook-utils manpages-dev
+$ autoconf
+$ ./configure  # optionally, use: --without-sendmail
+$ make updatedoc
+```