yo8192 / fcron

fcron is an advanced cron for Linux/Unix systems
http://fcron.free.fr
GNU General Public License v2.0
131 stars 12 forks source link

Catch-22: documentation you need to read to figure out how to generate the documentation doesn't come pre-generated when you just git clone the repo?? #21

Closed dwawlyn closed 1 year ago

dwawlyn commented 1 year ago

For the github, the README just says:

See readme.txt in directory doc/en/txt/
 or readme.html in directory doc/en/HTML/.

I think this is a Catch-22?

That html documentation is what you need to read to figure out how to generate a bunch of stuff, including the very documentation you need to read??

(It seems to only come with the .sgml files obviously accessible, and those are significantly harder to read in their raw form.)

So I ended up downloading: http://fcron.free.fr/archives/fcron-3.2.1.src.tar.gz from: http://fcron.free.fr/download.php cuz that was the easiest way to figure out how to use the git clone!

Thanks!

( fcron is such a nice improvement on the more generally available defaults, so I was hoping I might be able to help a little to make it more available on more distros.

(Specifically, I'm poking at getting it well-integrated into my opensuse tumbleweed install here.) )

yo8192 commented 1 year ago

That's a good point. This stems from the expectation people would first go to the website http://fcron.free.fr, which used to be the case before I moved the git repo to Github.

I've expanded the README to point to the doc on http://fcron.free.fr, and explain how to build the doc for people who would prefer doing that.

In parallel I've tried looking into how to build and publish the doc as Github pages. The workflow I created seems to build the doc artifact ok, but I haven't found how to publish it yet.

yo8192 commented 1 year ago

Actually it did publish it now: https://yo8192.github.io/fcron/.