From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Akib Azmain Turja Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Sun, 05 Jun 2022 17:59:30 +0600 Message-ID: <87tu8z48yl.fsf@disroot.org> References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33063"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Michael Albinus , Alan Mackenzie , Stefan Kangas , emacs-devel@gnu.org To: Tassilo Horn , Po Lu Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 05 14:07:52 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 1nxp2t-0008V8-OB for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 14:07:51 +0200 Original-Received: from localhost ([::1]:39474 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxp2s-0000us-GE for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 08:07:50 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42890) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxovs-0006RF-I2 for emacs-devel@gnu.org; Sun, 05 Jun 2022 08:00:54 -0400 Original-Received: from knopi.disroot.org ([178.21.23.139]:34980) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxovo-0005Ga-Sd; Sun, 05 Jun 2022 08:00:36 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id 61075437AB; Sun, 5 Jun 2022 14:00:30 +0200 (CEST) X-Virus-Scanned: SPAM Filter at disroot.org Original-Received: from knopi.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavisd-new, port 10024) with UTF8SMTP id wW9GOKYRZ-7t; Sun, 5 Jun 2022 14:00:29 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1654430418; bh=K+xj7CLNm/OmihdCU3vvuo0mQea18Lx+MqEDpFl+s0o=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=DbA9tC0One1HyBISjrZOMv356rz2bMKIcB5G1YwYwpvTFkXHTZVMH8+VcWcCkMN+Y 3jPWBLVVd93hN8PLd85uwu3BAZEnYGNPppt/VbeHYe3CVlo2TZe535Q+t2L+8hxM/B bEdxOf5fW15dYA8x5upER7JXM6zm+0mTuDKPhfyT6EmhfdrgJ+ZRVLUYSiCqN8GHC2 fvs+3ZtxUlqgtf2/GyPLsffbiJk5R1+9dfgtsGTyLFQ2CbMrJJAo73yP9V0YVGAeTB WzZOcaEpDqG6XBptFhBQiyexQDMnS5Na45eBtMjJOfUt5DXTaHPx/qwsz4IBXPgw78 tpYPmpTQFYasg== In-Reply-To: <8735gj4ceo.fsf@gnu.org> Received-SPF: pass client-ip=178.21.23.139; envelope-from=akib@disroot.org; helo=knopi.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action 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:290698 Archived-At: --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Tassilo Horn writes: > 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 I can't understand why you are suggesting to emulate (or enable) Org syntax highlighting in package description. 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). =2D-=20 Akib Azmain Turja This message is signed by me with my GnuPG key. It's fingerprint is: 7001 8CE5 819F 17A3 BBA6 66AF E74F 0EFA 922A E7F5 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEyVTKmrtL6kNBe3FRVTX89U2IYWsFAmKcmqIACgkQVTX89U2I YWsSGA//WVOo49MHSA4uB+vevYOcesaJFiBXYHRcEdX624a4Kl1EpNDsadUrB5y/ QXu7ipILG7T0imFKcLx3xXnESzsmZjt/k6aXOcqeue+LrQhOKjLWSpbu6km/i/Yi ZnN5If5CiVKboPXa5vOjbZ7KCkjIg4Lz/iK/FJVP1cV8O9qrtghf52yvX/qPhNTU p1QNCSSzD9cnXGLRoagXSFFWGw/4sKfCpT02KlGh8/u5LrsviceQT+xkI4oujuXw Lupl1G+P4uaS1bFObzBZcHcLaGhOp3FHCFZRulJTxExWFCGLVwOEv7ElgbOC5mQg I07CYdsvSqGFeMb0V4tSdyWmQ9y3oFsux7xKiPij+QoY+A052AfIQN+fFvmzvUu9 9wPLSqDy8fDOFvHfe59t95xYWwHOQ7cDBG6PI8DNAEuQG+Yds30SpTC9Ayo/I64E rQu9K5fjTvSuHm8MUpTMs7AOlIxH0HhHAtyB/rrxTqPJL7d2+Yu5tgoopX0bmRMj TNFu6LUMHXe9Kzm76RaUk1Ia3kx/wjX2IWdR5dRKs9VOvPjdiDchEe6UwSHgpAMS SEDeNFVNt4V2TWEL/DxcbNQTtMW0yZAjzCWD+KZa6/4N7TG+buSwVTBJvf5+pJpH pF7gYDCfM2oGLY+/SQdPpGUbOyQhU7tpiIISF/MXlID+4TLETGU= =yaLy -----END PGP SIGNATURE----- --=-=-=--