summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien <bzg@gnu.org>2020-01-27 15:49:13 +0100
committerBastien <bzg@gnu.org>2020-01-27 15:49:13 +0100
commit605b6a6b535549012cefdef0e5210e29d3563728 (patch)
tree5fb04c2732ab660ff17c0f81d2c4f36bb108c5cf
parent5f241b134c28110bf55154ea5e0c33803fa24366 (diff)
downloadorg-mode-605b6a6b535549012cefdef0e5210e29d3563728.tar.gz
README: Use org-mode formatting
-rw-r--r--README56
1 files changed, 24 insertions, 32 deletions
diff --git a/README b/README
index 19078a8..bb45e89 100644
--- a/README
+++ b/README
@@ -1,47 +1,39 @@
+-*- mode: org; fill-column:70 -*-
+
This is a distribution of Org, a plain text notes and project planning
tool for Emacs.
-The homepage of Org is at:
- https://orgmode.org
+Check the [[https://orgmode.org][homepage of Org]] and the [[https://orgmode.org/org.html#Installation][installations instructions]].
-The installations instructions are at:
- https://orgmode.org/org.html#Installation
+* Contents of this distribution
-This distribution contains:
+- README :: This file.
-README
- This file.
+- COPYING :: The GNU General Public License.
-COPYING
- The GNU General Public License.
+- Makefile :: The makefile to compile and install Org. For installation
+ instructions, see the manual or [[https://orgmode.org/worg/dev/org-build-system.html][the more detailed procedure on Worg]].
+
+- mk/ :: Files needed for building Org.
-Makefile
- The makefile to compile and install Org. For installation
- instructions, see the manual or the more detailed procedure
- on Worg: https://orgmode.org/worg/dev/org-build-system.html
+- lisp/ :: Directory with all the Emacs Lisp files that make up Org.
-mk/
- Files needed for building Org.
+- doc/ :: The documentation files. org.texi is the source of the
+ documentation, org.html and org.pdf are formatted versions of it.
-lisp/
- Directory with all the Emacs Lisp files that make up Org.
+- contrib/ :: A directory with third-party additions for Org. Some
+ really cool stuff is in there.
-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.
-contrib/
- A directory with third-party additions for Org. Some really cool
- stuff is in there.
+- testing/ :: Testing suite for Org.
-etc/
- Files needed for the ODT exporter.
+- request-assign-future.txt :: The form that contributors have to sign
+ and get processed with the FSF before contributed changes can be
+ integrated into the Org core. All files in this distribution except
+ the contrib/ directory have copyright assigned to the FSF.
-testing/
- Testing suite for Org.
+* License
-request-assign-future.txt
- The form that contributors have to sign and get processed with
- the FSF before contributed changes can be integrated into the Org
- core. All files in this distribution except the contrib/ directory
- have copyright assigned to the FSF.
+Org-mode is published under the GNU GPLv3 license or any later version,
+the same as GNU Emacs. See the COPYING file in this directory.