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 12:26:44 +0200 Message-ID: <8735gj4ceo.fsf@gnu.org> References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="14472"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: mu4e 1.7.26; emacs 29.0.50 Cc: Michael Albinus , Alan Mackenzie , Stefan Kangas , Akib Azmain Turja , emacs-devel@gnu.org To: Po Lu Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 05 12:52:18 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 1nxnrm-0003ZV-LJ for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 12:52:18 +0200 Original-Received: from localhost ([::1]:58690 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxnrl-0004Xw-C1 for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 06:52:17 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:33976) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxnlU-0003A8-FH for emacs-devel@gnu.org; Sun, 05 Jun 2022 06:45:48 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:41320) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxnlP-0002JP-Te; Sun, 05 Jun 2022 06:45:46 -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=8RRkCV+I2i1V/58AwB1MH/XBmKXPCXqqmMTJX/HYqBY=; b=CeicKnh0C6mNqH ow2P2cSUcTgFjw45gMLncfHmPs8fJx4fw8AI8vDKVYf0RCliSe3Ra197HvKgeZPxhRcAbFA20OqeK 08wMAJq+qswopTSwpRKyaSN1upSaDZ132fsno/QMzFri0QrXTc0LVSKIDEAjpv9iy8X0OcYcdDGDH ml2q3nDXQmDRwEZKSnRhaTPZ9p1MhEVIIWF8tkJH59gtQfvFcRs2i3xHxtCL+BGjC/4Uey5/Odlz4 rhq6WxaAcXkyzt3bcwyhdjXeUl9N05iSmgg0m13s1ha1mGClAbz2HHHRQmARJHhUJIx4MlfngaA2u khcTK8jUx+BYTO4aiESg==; Original-Received: from auth1-smtp.messagingengine.com ([66.111.4.227]:52739) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nxnkp-0003mr-DU; Sun, 05 Jun 2022 06:45:34 -0400 Original-Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailauth.nyi.internal (Postfix) with ESMTP id 01F6C27C005B; Sun, 5 Jun 2022 06:45:05 -0400 (EDT) Original-Received: from mailfrontend2 ([10.202.2.163]) by compute3.internal (MEProxy); Sun, 05 Jun 2022 06:45:06 -0400 X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedruddttddgfedvucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhepfhgfhffvvefuffgjkfggtgesthdtredttdertdenucfhrhhomhepvfgrshhs ihhlohcujfhorhhnuceothhsughhsehgnhhurdhorhhgqeenucggtffrrghtthgvrhhnpe dttefhudeiffevhfevtddtudelieeggfdthfehgfevgeetvdethfeljeeuveevieenucff ohhmrghinheprhgvrggumhgvrdhorhhgnecuvehluhhsthgvrhfuihiivgeptdenucfrrg hrrghmpehmrghilhhfrhhomhepthhhohhrnhdomhgvshhmthhprghuthhhphgvrhhsohhn rghlihhthidqkeeijeefkeejkeegqdeifeehvdelkedqthhsughhpeepghhnuhdrohhrgh esfhgrshhtmhgrihhlrdhfmh X-ME-Proxy: Feedback-ID: ib2b94485:Fastmail Original-Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sun, 5 Jun 2022 06:45:04 -0400 (EDT) In-reply-to: <871qw31ois.fsf@yahoo.com> 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:290686 Archived-At: Po Lu writes: >>>> I think we should actively encourage using it for most types of >>>> documentation, certainly for README type files. >>> >>> I disagree entirely with you. Org mode is highly complicated, >>> obscure (I've never managed to get a feel for what it does), and >>> difficult to learn (I've never managed it). A text file is far >>> easier to read for those not familiar with org. We're talking about >>> READMEs here. They're typically 20 to 100 lines long. A text file >>> is ideal for these. >> >> 1+. README is a text file which is consulted in order to get >> information about the related software. There's no rule to visit it >> by Emacs only. People nowadays write README.org and README.md files instead of plain-text READMEs because the packages' repositories are hosted on some forge (sr.ht, github, gitlab, gitea, whatever) which supports rendering those formats in a nice way. So the choice of format is natural for package authors. And they frequently contain markup like headings, bullet lists, bold, italics, and code snippets which simply look much better than their text-only alternative (even in their editing/non-rendered versions). > Hear, hear! > > It also takes a relatively long time to load Org mode, so opening a > README.org-type file for the first time will always cause an annoying > pause. That's true but wouldn't it be possible to extract the font-lock/faces related parts in a separate file with no dependencies which can be loaded quickly enough? I mean, the purpose would only be to display org and markdown READMEs with the highlighting intended by the package author but there's no point in enabling the gazillon of other features (from editing to time-tracking to spreadsheet computations) those packages might provide in addition. Bye, Tassilo