Browse Source

README: Use org-mode formatting

Bastien 1 year ago
parent
commit
605b6a6b53
1 changed files with 24 additions and 32 deletions
  1. 24 32
      README

+ 24 - 32
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.