From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Tim Cross Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Mon, 06 Jun 2022 10:19:38 +1000 Message-ID: <87o7z61v59.fsf@gmail.com> References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org> <87ee038ipt.fsf@gmx.de> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2833"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: mu4e 1.7.26; emacs 28.1.50 To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jun 06 02:43:32 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 1ny0qB-0000am-Je for ged-emacs-devel@m.gmane-mx.org; Mon, 06 Jun 2022 02:43:31 +0200 Original-Received: from localhost ([::1]:43686 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ny0q9-0003fN-Un for ged-emacs-devel@m.gmane-mx.org; Sun, 05 Jun 2022 20:43:29 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42632) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ny0nd-00005E-3F for emacs-devel@gnu.org; Sun, 05 Jun 2022 20:40:54 -0400 Original-Received: from mail-pl1-x62a.google.com ([2607:f8b0:4864:20::62a]:45641) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ny0nb-00083y-IG for emacs-devel@gnu.org; Sun, 05 Jun 2022 20:40:52 -0400 Original-Received: by mail-pl1-x62a.google.com with SMTP id q18so10898082pln.12 for ; Sun, 05 Jun 2022 17:40:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=references:user-agent:from:to:subject:date:in-reply-to:message-id :mime-version; bh=FaUaoiE6hmm4sBGVebzoNJFhAeY4K4wBUXBUiS0DC/A=; b=dgmfyCAMUsoR+PVPYGepeUDt0AoWaWYipkiv+AU8VQRRdZGwZXPcuBnSiz2Mt9bsdd 3eztKTEXpJ3v48KE3ExjKdiRvxAOAxc84X6zVmMPix9sNIOXQvO6GLx1uMjj4z2jCbPZ 2ycWegSZDKncIVjW/A43tgDDOI5+5F6oAiLRh6LTKQIxyDhM/rekalmjswqWsdcmJnia K68kTreB2SejyX70n+6yQWvLK8gD+6rOiMeV6T+Hri6DsPr2np/OoRD6WFih/1qSUcAY KaGcuNQGrxewm34spfizE9DgYxMX5wb4QQDlPZXAsmVbze3gzHcVNKkAdR5kEvn8Zieh iQWg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:references:user-agent:from:to:subject:date :in-reply-to:message-id:mime-version; bh=FaUaoiE6hmm4sBGVebzoNJFhAeY4K4wBUXBUiS0DC/A=; b=N2+7/MizHA9ndoEKMyqdc/1WwDniUR7lM9yd2c0HW6r/lNtfyx05dQvUlBQDb54U+3 FmEKz9EToqskr7xmKo/B2DEDDArXwfryvidlEGxFCw5Ik0Zgp7FtJGVpTRWKX5THgTRp 0EVP2/SV/9HpWbFVpN2cd1eXeSFOUMSyQI8uwNLPkeKhUdRrlsvZgCwkPufv9y9D1kP8 ozCWCxMvbNm2HFebHjJ62bM1YQ7poCP30P96zsWo8oOl3sTFJ+pGwXPwMnVCtAgYG6uI Z1Ox4F3oXcpEC1VMcpdw5avWtIct/sAD19ljpOn7xGNg2tKIJgOm0hossBUmlwzUZLfZ El/g== X-Gm-Message-State: AOAM533m/joDqyUr23FrfFOhbnl9ae8Zny1RvARr9UxpM75k9JPU5Dzy ujLktMG6wejVvJH6ul1xium6EX9+3U8= X-Google-Smtp-Source: ABdhPJxYh5rM2Xg9pJHgB7y0S3vE4WaHt0/yaFp7BSwnN5mTJZNxqEYNvmTmdxnSBBmrOTyIAL5VAQ== X-Received: by 2002:a17:903:1211:b0:15e:8208:8cc0 with SMTP id l17-20020a170903121100b0015e82088cc0mr22050462plh.52.1654476049821; Sun, 05 Jun 2022 17:40:49 -0700 (PDT) Original-Received: from dingbat (2001-44b8-31f2-bb00-3884-712f-51c3-8d43.static.ipv6.internode.on.net. [2001:44b8:31f2:bb00:3884:712f:51c3:8d43]) by smtp.gmail.com with ESMTPSA id ei13-20020a17090ae54d00b001e31c7aad6fsm8873039pjb.20.2022.06.05.17.40.48 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 05 Jun 2022 17:40:49 -0700 (PDT) In-reply-to: <87ee038ipt.fsf@gmx.de> Received-SPF: pass client-ip=2607:f8b0:4864:20::62a; envelope-from=theophilusx@gmail.com; helo=mail-pl1-x62a.google.com 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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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:290758 Archived-At: Michael Albinus writes: > > I have no problem if there are structured README.org or README.md files > in parallel. But a README file should be plain text. > I've seen this mentioned multiple times in this thread and it doesn't make sense to me. Org files *are* plain text. This is one of (perhaps the biggest) selling points for org mode. They don't use any form of 'binary' data and can be read just fine in any text editor or just using cat/less/more whatever. They may look a little *ugly*, especially with respect to URLs, but are still quite readable - a lot more readable than other plain text formats such as xml or html or json etc. I also find arguments based around org being complex and difficult to learn to be somewhat overstated. Org is powerful and very configurable, which means there can be a lot to learn if you want to leverage off all it has to offer. However, like emacs, the basics are very simple and easy to learn. While I'm not arguing that org should be forced upon everyone and I would agree we need to keep potential load time issues in mind, there seems to be lots in this thread over stating the issues and jumping to extremes. All that seems to really be under consideration is to enable rendering of *org files in help buffers using org font locking and perhaps enabling folding, which could be very beneficial for large readme files and would not matter for small ones. I also suspect this is something which could be disabled with a simple variable setting for those who really don't like it.