emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: phillip.lord@newcastle.ac.uk (Phillip Lord)
To: Thierry Banel <tbanelwebmin@free.fr>
Cc: emacs-orgmode@gnu.org
Subject: Re: Lentic.0.6 and org mode
Date: Thu, 15 Jan 2015 22:41:19 +0000	[thread overview]
Message-ID: <87sifb3bw0.fsf@newcastle.ac.uk> (raw)
In-Reply-To: <54B828DC.8010102@free.fr> (Thierry Banel's message of "Thu, 15 Jan 2015 21:53:48 +0100")

Thierry Banel <tbanelwebmin@free.fr> writes:

> Le 15/01/2015 17:11, Phillip Lord a écrit :
>>>> 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

> 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.


  reply	other threads:[~2015-01-15 22:41 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-08 13:55 Lentic.0.6 and org mode Phillip Lord
2015-01-08 22:24 ` Thierry Banel
2015-01-11 12:33   ` joakim
2015-01-15 16:11     ` Phillip Lord
2015-01-15 20:53       ` Thierry Banel
2015-01-15 22:41         ` Phillip Lord [this message]
2015-01-16 18:43           ` Thierry Banel
2015-01-16 20:18             ` Thomas S. Dye
2015-01-16 23:46               ` Phillip Lord
  -- strict thread matches above, loose matches on Subject: below --
2015-01-09 17:12 Phillip Lord
2015-01-09 17:57 ` Alan Schmitt
2015-01-09 19:18 Phillip Lord
2015-01-10 12:35 ` Alan Schmitt
2015-01-15 15:54   ` Phillip Lord
2015-01-15 17:24     ` Alan Schmitt
2015-01-15 22:28       ` Phillip Lord
2015-01-16 10:15         ` Alan Schmitt
2015-01-16 11:01           ` Phillip Lord

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87sifb3bw0.fsf@newcastle.ac.uk \
    --to=phillip.lord@newcastle.ac.uk \
    --cc=emacs-orgmode@gnu.org \
    --cc=tbanelwebmin@free.fr \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox


This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).