More markdown formatting in README.md

README.md

@@ -1,78 +1,45 @@
-                             The Example package
+# The Example package
 
-This is the README file for the GAP package "Example".
+* Website: gap-packages.github.io/example/
+* Repository: https://github.com/gap-packages/example
 
-This package serves  as an example of how to create a GAP 4 package.
-This release (3.X.Y) has been updated for the changes in the package 
-loading mechanism introduced in GAP 4.5. 
+This package serves as an example of how to create a GAP 4 package.
 
-The package is distributed with the main GAP archive. For updates
-between releases of GAP itself check the package Web pages
+The Example package uses an external binary and therefore a complete
+installation only works on UNIX systems or systems that support a
+UNIX-like environment, e.g. OS X, or Windows with Cygwin. However, 
+a partial installation without the external binary is possible on 
+any system.
 
-    http://www.cs.st-andrews.ac.uk/~alexk/example/
-    http://www.math.rwth-aachen.de/~Greg.Gamble/Example
-
-or the Australian mirrors
-
-	http://www.maths.uwa.edu.au/~gregg/Example/ (Perth, Australia)
-	http://www.itee.uq.edu.au/~gregg/Example/   (Queensland, Australia)
-
-or via the Packages links from the GAP website 
-
-	http://www.gap-system.org/                     
-
-or the GAP ftp server, dependently on the preferred archive format:
-
-	ftp://ftp.gap-system.org/pub/gap/gap4/tar.gz/packages/
-	ftp://ftp.gap-system.org/pub/gap/gap4/tar.bz2/packages/
-	ftp://ftp.gap-system.org/pub/gap/gap4/win.zip/packages/
-
-The Example package uses an external binary and therefore  a  complete
-installation only works on UNIX systems  or  systems  that  support  a
-UNIX-like   environment,  e.g.  Mac OS X,   or  Windows  with  Cygwin.
-However,  a  partial  installation  without  the  external  binary  is
-possible on any system.
-
-     Installing  a complete Example package (with external binary)
-
-To  complete the  installation of  the ``Example''  package go  to the
-directory `example'  created (the  directory contains  a copy  of this
-README file) and call
-
-	/bin/sh ./configure <path>
+To compile the package, change to the `/pkg/example-*` directory 
+of your GAP installation and then call
+
+	./configure <path>
 
 where <path> is a path to the main GAP root directory; so normally you
 would call
 
-	/bin/sh ./configure ../..
+	./configure ../..
 
-(the ../.. is the default and so may be omitted) and then call
+(the `../..` is the default and so may be omitted) and then call
 
 	make 
 
 to compile the binary.
 
-If you installed GAP on several architectures, you  must  execute  the
-configure/make steps for  the  ``Example''  package  on  each  of  the
-architectures  immediately  after  configuring  GAP  itself  on   this
-architecture.
-
-That's it. Now start GAP and type
+Now start GAP and type
 
 	LoadPackage("example");
 
-The ``Example" package banner should appear on the screen. If you have
-not compiled the external binary, you  should  receive  a  warning  of
-this.
+to load the package. You will see the package banner. If you have
+not compiled the external binary, you should receive a warning.
 
-For details on  how  to  use  the  Example  package  see  the  package
-documentation  in  the  `doc'  subdirectory  (view its HTML version or 
-`manual.pdf'  via a PDF viewer). You will find  additional information 
+For details on how to use the Example package see the package
+documentation in the `doc` subdirectory (view its HTML version or 
+`manual.pdf`  via a PDF viewer). You will find additional information 
 on how to create a GAP package in the Appendix of the manual.
 
-  Werner Nickel,
-  Greg Gamble -- 12 February, 2002; 13 January, 2003; 20 June, 2003;
-                 31 January, 2006.
-  Alexander Konovalov (since March 2011).
-
-  Contact: alexk at mcs.st-andrews.ac.uk
+Maintainers:
+* Werner Nickel (before 2002)
+* Greg Gamble (2002-2006)
+* Alexander Konovalov (since 2011)