From mboxrd@z Thu Jan 1 00:00:00 1970 From: phillip.lord@newcastle.ac.uk (Phillip Lord) Subject: Re: Lentic.0.6 and org mode Date: Thu, 15 Jan 2015 22:41:19 +0000 Message-ID: <87sifb3bw0.fsf@newcastle.ac.uk> References: <87zj9tml69.fsf@newcastle.ac.uk> <54AF03A8.1070102@free.fr> <87r3uw81na.fsf@newcastle.ac.uk> <54B828DC.8010102@free.fr> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:48307) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YBt6V-00035L-3e for emacs-orgmode@gnu.org; Thu, 15 Jan 2015 17:41:28 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YBt6Q-0002SM-3G for emacs-orgmode@gnu.org; Thu, 15 Jan 2015 17:41:27 -0500 Received: from cheviot22.ncl.ac.uk ([128.240.234.22]:50661) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YBt6P-0002S8-TN for emacs-orgmode@gnu.org; Thu, 15 Jan 2015 17:41:22 -0500 In-Reply-To: <54B828DC.8010102@free.fr> (Thierry Banel's message of "Thu, 15 Jan 2015 21:53:48 +0100") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Thierry Banel Cc: emacs-orgmode@gnu.org Thierry Banel writes: > Le 15/01/2015 17:11, Phillip Lord a =C3=A9crit : >>>> I spent some time figuring out how to use it. >> Of course, even when installed from Melpa it is self-documenting in the >> sense that the source files are full of documentation. The lentic-org.el >> file contains a description of how to convert an existing file from >> being an normal el file to an "orgel" file (which is the name I have >> given to an el file that converts cleanly to an org file with lentic). >> >> I could translate these to info (via org-mode and texinfo). But melpa >> presents a challenge here, since it works on the source only, and I need >> to generate the texinfo from the source, at least as far as I know. So, >> unless, I can get MELPA to run arbitrary lisp during build, I do not >> know how this would work. Or I could denormalise my git repo and >> put the generated files in there; not ideal. >> >> > > One possibility, not as good as info, but quite easy, is given by > GitHub. Replace your current README.md with a README.org, in org-mode > syntax. Why this replacement? md or org should both work right? Or am I missing something? > Then tell Melpa that the Lentic home page is > https://github.com/phillord/lentic. I think it already has this. > And begin this documentation with a "quick start" chapter. I'm trying to avoid putting too much in README because it is already documented in lentic and the other sources -- although, its clearly not easy for people to find these. For the next version, I will write some local tools to generate HTML from source. Then I can expand the README to just point to those. And, yes, an easy to find "quick-start" chapter would be good. Phil