From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Tassilo Horn Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Sun, 05 Jun 2022 17:32:43 +0200 Message-ID: <87ee033w7h.fsf@gnu.org> References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org> <87sfojz63r.fsf@yahoo.com> <87h74z5nio.fsf@localhost> <87ilpf45mo.fsf@disroot.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="6014"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: mu4e 1.7.26; emacs 29.0.50 Cc: Ihor Radchenko , Po Lu , Michael Albinus , Alan Mackenzie , Stefan Kangas , emacs-devel@gnu.org To: Akib Azmain Turja Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 05 18:36:34 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nxtEw-0001Nh-18 for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 18:36:34 +0200 Original-Received: from localhost ([::1]:56770 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxtEu-0005wC-QB for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 12:36:32 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50340) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxtDT-00051b-LP for emacs-devel@gnu.org; Sun, 05 Jun 2022 12:35:03 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:46526) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxtDT-0003a6-1V; Sun, 05 Jun 2022 12:35:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:In-reply-to:Date:Subject:To:From: References; bh=wDC8wVhLzqq8kwJUrmzskq+vpxBvL4gqiw5o7QeFemA=; b=F12JDi5W2/c/7a 0nzsUBI27Uh3gNwhgOLxEYanp6/oburvsnLIbnBnsin1hgtwXIjmTls6uUidMjFoB1NNkh4TNRqZn xmUGy41v0tMhvvFzr+aesNsogiKjuQMfXSXwMwo2aYtI5T7hHxnyzmEq6Ovw1yHNOQHP44vb9kEvb dWI4/LiQ72DGAuQfPhjBd4ogVAX012HZpq7vqCVk/vdU2Jumv0T3VtIR6B//R+W4DbnvlKWPoAGIx Pz7m+RGB0T8QQcEzVdu9LpGqjENKNcqZNLmezlVE3u8TwphuDLMxrxFxtdPyuFUGV2FqGtiVbPaB3 RduTpsGQcVNW8tC9P3Og==; Original-Received: from auth2-smtp.messagingengine.com ([66.111.4.228]:33959) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nxtDS-0002ja-R5; Sun, 05 Jun 2022 12:35:02 -0400 Original-Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailauth.nyi.internal (Postfix) with ESMTP id 5EDC427C0054; Sun, 5 Jun 2022 12:35:01 -0400 (EDT) Original-Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Sun, 05 Jun 2022 12:35:01 -0400 X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedruddttddguddtfecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpehffgfhvfevufffjgfkgggtsehttdertddtredtnecuhfhrohhmpefvrghs shhilhhoucfjohhrnhcuoehtshguhhesghhnuhdrohhrgheqnecuggftrfgrthhtvghrnh eptdethfduieffvefhvedttdduleeigefgtdfhhefgveegtedvtefhleejueevveeinecu ffhomhgrihhnpehrvggrughmvgdrohhrghenucevlhhushhtvghrufhiiigvpedtnecurf grrhgrmhepmhgrihhlfhhrohhmpehthhhorhhnodhmvghsmhhtphgruhhthhhpvghrshho nhgrlhhithihqdekieejfeekjeekgedqieefhedvleekqdhtshguhheppehgnhhurdhorh hgsehfrghsthhmrghilhdrfhhm X-ME-Proxy: Feedback-ID: ib2b94485:Fastmail Original-Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sun, 5 Jun 2022 12:34:59 -0400 (EDT) In-reply-to: <87ilpf45mo.fsf@disroot.org> X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:290735 Archived-At: Akib Azmain Turja writes: Hi Akib, > I can't understand why people are suggesting to Org mode in package > description. I'm not sure if we are miscommunicating. Of course, nobody should be mandated to write his package's README as org file. But as a matter of fact, many package authors do it that way or in markdown simply because both are good formats for structured text and are supported by most forges (markdown even more so), i.e., the rendered version of the README becomes the project's homepage without any additional work. IMHO, that's good: it encourages package authors to write good READMEs because it's the very first thing a prospective user will see. So again, I was only suggesting that if (and only if) a package declares a :readme "README.org" / "README.md", it would be nice if it was *displayed* as in the "native" modes. I certainly acknowledge technical arguments, e.g., loading the org package is too slow (right now). Let me ask the other way round: why can't you understand that someone thinks it's a good idea if the package description is displayed as the author intended? > I'm again saying that the README.org should be converted (exported) to > plain text on package installation (I won't recommend to do this > server, since its probably SaaSS and would increase server load). I've just tried org-exporting the vertico README.org to a plain-text UTF-8 version and have to confess, the result is really, really intriguing. So, yes, such a conversion is at least much better as the status quo where the org syntax is displayed literally without highlighting. (I almost don't perceive the org/markdown syntax when there's syntax highlighting but if there isn't, it looks annoying.) One problem with the "conversion on installation" approach you suggest is that this would load org, too, so the arguments against using/loading org for display would also apply here. Bye, Tassilo