[PATCH] Add .org suffixes to CONTRIBUTE and README

[PATCH] Add .org suffixes to CONTRIBUTE and README

[Bastien]

[-- Attachment #1: Type: text/plain, Size: 271 bytes --]

I'm considering apply the patch below, renaming CONTRIBUTE to
CONTRIBUTE.org and README to README.org.

The main benefit is to enhance the rendering of the README on 
GNU ELPA.

I also do some minor reformatting and remove the warning about
org-contrib.

Any objection?


[-- Attachment #2: 0001-WIP-on-main-ebbc2ffaa-Merge-remote-tracking-branch-github-main.patch --]
[-- Type: text/x-diff, Size: 3818 bytes --]

diff --git a/CONTRIBUTE b/CONTRIBUTE.org
similarity index 89%
rename from CONTRIBUTE
rename to CONTRIBUTE.org
index f8a81515e..fbd1616f5 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE.org
@@ -1,5 +1,3 @@
--*- mode: org; fill-column:70 -*-
-
 The text below explains the rules for participating in Org mode
 development.
 
@@ -66,9 +64,3 @@ Org maintenance is detailed on Worg: see [[https://orgmode.org/worg/org-maintena
      them and ask everyone to keep this in mind when posting changes.
 
 See [[https://orgmode.org/worg/org-contribute.html][worg/org-contribute]] for guidance on how to contribute effectively.
-
-* The =contrib/= directory
-
-The git repository used to contain a =contrib/= directory.  Files in
-this directory were moved to a new [[https://git.sr.ht/~bzg/org-contrib][org-contrib]] repository before Org
-9.5.  You can install the new =org-contrib= from [[https://elpa.nongnu.org/nongnu/][NonGNU ELPA]].
diff --git a/README b/README.org
similarity index 50%
rename from README
rename to README.org
index bb0a0c582..bf9301169 100644
--- a/README
+++ b/README.org
@@ -1,32 +1,16 @@
--*- mode: org; fill-column:70 -*-
+This is a distribution of Org Mode, a major mode for keeping notes,
+authoring documents, computational notebooks, literate programming,
+maintaining to-do lists, planning projects, and more — in a fast and
+effective plain text system.
 
-This is a distribution of Org, a plain text notes and project planning
-tool for Emacs.
+Check the [[https://orgmode.org][Org Mode website]] for more.
 
-Check the Org Mode website at https://orgmode.org and the installation
-instructions at https://orgmode.org/org.html#Installation.
+* Install Org
 
-* Contents of this distribution
+Org is part of GNU Emacs: you probably don't need to install it.
 
-- README :: This file.
-
-- COPYING :: The GNU General Public License.
-
-- Makefile :: The makefile to compile and install Org.  See the
-  installation instructions https://orgmode.org/org.html#Installation
-  or this more detailed procedure on Worg:
-  https://orgmode.org/worg/dev/org-build-system.html.
-  
-- mk/ :: Files needed for building Org.
-
-- lisp/ :: Directory with all the Emacs Lisp files that make up Org.
-
-- doc/ :: The documentation files.  org.texi is the source of the
-  documentation, org.html and org.pdf are formatted versions of it.
-
-- etc/ :: Files needed for the ODT exporter.
-
-- testing/ :: Testing suite for Org.
+To install a more recent version, please do it from [[https://elpa.gnu.org/packages/org.html][GNU ELPA]] by
+running this command: =M-x package-install RET org RET=
 
 * Join the GNU Project
 
@@ -36,19 +20,18 @@ System, developed by the GNU Project.
 If you are the author of an awesome program and want to join us in
 writing Free (libre) Software, please consider making it an official
 GNU program and become a GNU Maintainer.  Instructions on how to do
-this are here http://www.gnu.org/help/evaluation
+this are here http://www.gnu.org/help/evaluation.
 
 Don't have a program to contribute?  Look at all the other ways to
-help: https://www.gnu.org/help/help.html
+help: https://www.gnu.org/help/help.html.
 
 And to learn more about Free (libre) Software in general, please read
 and share this page: https://gnu.org/philosophy/free-sw.html
 
 * License
 
-Org-mode is published under the GNU GPLv3 license or any later
-version, the same as GNU Emacs:
-https://www.gnu.org/licenses/gpl-3.0.html
+Org-mode is published under the [[https://www.gnu.org/licenses/gpl-3.0.html][GNU GPLv3 license]] or any later
+version, the same as GNU Emacs.
 
 Org-mode is free software: you can redistribute it and/or modify it
 under the terms of the GNU General Public License as published by the

[-- Attachment #3: Type: text/plain, Size: 14 bytes --]


-- 
 Bastien

Re: [PATCH] Add .org suffixes to CONTRIBUTE and README

[Timothy]

[-- Attachment #1: Type: text/plain, Size: 337 bytes --]

Hi Bastien,

> I’m considering apply the patch below, renaming CONTRIBUTE to
> CONTRIBUTE.org and README to README.org.

I’ve actually been thinking “why don’t we add .org?” for a while now, so I’d be
glad to see this changed.

The other changes you’ve made all look sensible to me 👍.

All the best,
Timothy

Re: [PATCH] Add .org suffixes to CONTRIBUTE and README

[Christopher M. Miles]

[-- Attachment #1: Type: text/plain, Size: 748 bytes --]


Bastien <bzg@gnu.org> writes:

> I'm considering apply the patch below, renaming CONTRIBUTE to
> CONTRIBUTE.org and README to README.org.
>
> The main benefit is to enhance the rendering of the README on 
> GNU ELPA.
>
> I also do some minor reformatting and remove the warning about
> org-contrib.
>
> Any objection?
>
> [2. text/x-diff; 0001-WIP-on-main-ebbc2ffaa-Merge-remote-tracking-branch-github-main.patch]...

I agree this change too. This is more clear.

-- 

[ stardiviner ]
I try to make every word tell the meaning that I want to express without misunderstanding.

Blog: https://stardiviner.github.io/
IRC(libera.chat, freenode): stardiviner, Matrix: stardiviner
GPG: F09F650D7D674819892591401B5DF1C95AE89AC3

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]

Re: [PATCH] Add .org suffixes to CONTRIBUTE and README

[Bastien]

"Christopher M. Miles" <numbchild@gmail.com> writes:

> I agree this change too. This is more clear.

Applied on main as 52be6f0f4, thanks.

-- 
 Bastien