Open masatake opened 3 years ago
Thanks!
I can confirm it works well.
If a user manually installed Citre, they can add the docs
dir to Info-directory-list
to visit them by C-h i
. However, I'm thinking for those who installed Citre use a package manager, like MELPA or straight.el (I use the latter one).
For them to automatically install the info files, we need to keep at least the *.texi
files in the source tree. This is clear to see the default files used by MELPA to build the package:
("*.el" "*.el.in" "dir"
"*.info" "*.texi" "*.texinfo"
"doc/dir" "doc/*.info" "doc/*.texi" "doc/*.texinfo"
(:exclude ".dir-locals.el" "test.el" "tests.el" "*-test.el" "*-tests.el"))
straight.el uses the same set of default files, as far as I know.
So what we need to do is:
*.texi
files or *.info
files. I think keeping *.texi
files are better since they are the "source code".$ make info
when commit?make
build them into the root directory of Citre. Or we can still build them into docs
, but then we need to modify the Citre recipe on MELPA.Also, I don't know if it can be done with texinfo: Can we convert README.md
into a texinfo file, and the links in it (to those manuals) still work?
README.md
covers most useful info users, and is often mentioned in user manuals.
Signed-off-by: Masatake YAMATO yamato@redhat.com