Convert README to Markdown for nice GitHub viewing

As suggested in GitHub issue #99. Along the way, update some things that needed it.
interchange · May 15, 2018 · 027f3df · 027f3df
1 parent 5799e40
commit 027f3df
Show file tree

Hide file tree

Showing 10 changed files with 192 additions and 189 deletions.
diff --git a/MANIFEST b/MANIFEST
@@ -1187,7 +1187,7 @@ MANIFEST			This list of files
 MANIFEST.SKIP
 MYMETA.json
 MYMETA.yml
-README
+README.md
 README-DEVELOPMENT
 README.debian
 README.rhel

diff --git a/Makefile.PL b/Makefile.PL
@@ -161,7 +161,7 @@ sub copyright_prompt {
 
  Interchange V$VERSION
  
- Copyright (C) 2002-2017 Interchange Development Group.
+ Copyright (C) 2002-2018 Interchange Development Group.
  Copyright (C) 1996-2002 Red Hat, Inc.
  Interchange is free under the terms of the GNU General Public License.
 

diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,177 @@
+# Interchange
+
+Interchange is a web application server, electronic catalog and database
+display system. Features include:
+
+* online ordering
+* real-time credit card processing hooks
+* high-level database access and retrieval with SQL support
+* product categorizing, merchandising, and discounting
+* basic customer relationship management
+* dynamic content presentation
+* content management
+* internationalization and localization support
+* real-time tax and shipping hooks
+* reporting
+* web-based administration
+
+## License
+
+Licensed under GPLv2. This program is offered without warranty of any kind.
+See file LICENSE for redistribution terms.
+
+Copyright (C) 2002-2018 Interchange Development Group  
+Copyright (C) 1996-2002 Red Hat, Inc.  
+Originally based on Vend 0.2 and 0.3, copyright 1995-96 by Andrew M. Wilcox.
+
+## Documentation
+
+More information is in the following files:
+
+### README.rpm-dist
+
+Notes on using Interchange when installed from RPM packages.
+
+### README.debian
+
+Notes on using Interchange when installed from Debian packages.
+
+### README-DEVELOPMENT
+
+How to access the Git repository to track ongoing development.
+
+### doc/WHATSNEW-\*
+
+Changes per specified version family.
+
+### UPGRADE
+
+Instructions on how to upgrade from an earlier Interchange version.
+
+A documentation package is available, with documentation in many different
+formats. This and other information is available at the Interchange home on
+the web:
+
+http://www.icdevgroup.org/
+
+## Repository layout
+
+Major files and directories in the distribution:
+
+### Makefile.PL
+
+Script to create a Makefile, used for installation. (Run `./configure` for usage instructions)
+
+### dist/
+
+The distribution files, exclusive of executable files and modules. Includes:
+
+* interchange.cfg.dist - Distribution-default interchange.cfg
+* strap/ - Demo catalog skeleton, used by makecat
+* src/ - C and Perl code for CGI link programs
+* lib/ - Back-end administrative interface
+* code/ - Usertags and other customizable code
+
+### hints.pl
+
+OS-specific configuration settings.
+
+### eg/
+
+Various helper scripts and addons.
+
+### lib/
+
+The library modules needed to run Interchange.
+
+### scripts/
+
+The executable files, relocated to bin/ in the install directory.
+
+### relocate.pl
+
+Script that adjusts paths in scripts/ for installation into bin/.
+
+### test.pl
+
+The installation test script.
+
+## Prerequisites
+
+Interchange requires Perl 5.8.5 or later, on a Unix-like operating
+system. It is primarily used on various Linux distributions, and has
+also been used on FreeBSD, OpenBSD, macOS, and other Unix variants.
+
+Interchange requires some extra Perl modules to be installed on
+your system. Unless you are installing from distribution-specific packages
+(Red Hat, Debian, etc.) the quick way to install the necessary support is to
+run from the untarred Interchange directory:
+
+```
+cpanm --installdeps .
+```
+
+Alternatively, you can run:
+
+```
+perl -MCPAN -e 'install Bundle::Interchange'
+```
+
+If you would like to use a specific installation of Perl, invoke
+Perl with an absolute path to the perl binary, such as
+
+```
+/usr/local/bin/perl -MCPAN -e 'install Bundle::Interchange'
+```
+
+## Installation
+
+You can install Interchange as root for a multi-user system-wide setup, or
+as an unprivileged user who will be the only one modifying Interchange files.
+
+Here is the quick installation summary:
+
+```
+tar xvzf interchange-5.12.0.tar.gz
+cd interchange-5.12.0
+perl Makefile.PL
+make
+make test
+make install
+```
+
+If you would like to use a specific version of Perl, simply invoke
+with an absolute path to the perl binary, such as:
+
+```
+/usr/local/bin/perl Makefile.PL
+```
+
+The build procedure asks where you'd like to install Interchange and
+the name of the user account that will own the installation.
+
+The Interchange server doesn't do much if it isn't servicing one or more
+actual catalogs, so you next need to make your first Interchange catalog,
+as described in the next section.
+
+## Demo catalog
+
+There is a demo catalog skeleton (called 'strap') included.
+
+To build your own catalog from the demo, go to the directory where you
+installed Interchange (default is "interchange" in your home directory,
+/usr/local/interchange for root installations, or /usr/lib/interchange
+for RPM installations) and run:
+
+```
+bin/makecat
+```
+
+Follow the prompts and after restarting the Interchange server you
+should be able to access the new instance of the demo catalog.
+
+Please note that some functionality (notably the reporting features)
+may not be available if you are not using an SQL database such as
+MySQL or PostgreSQL.
+
+Visit http://demo.icdevgroup.org/ to try out a live demo.
diff --git a/SPECS/interchange.spec b/SPECS/interchange.spec
@@ -249,7 +249,7 @@ exit 0
 %defattr(-, root, root)
 
 %doc LICENSE
-%doc README
+%doc README.md
 %doc README.rpm-dist
 %doc README-DEVELOPMENT
 %doc UPGRADE

diff --git a/UPGRADE b/UPGRADE
@@ -345,7 +345,7 @@ based on Foundation and not heavily customized (i.e. using global UserTag
 routines).
 
 1. Install the new Interchange 5.x.x in /usr/lib/interchange-5.x.x
-using the procedure from the README file.
+using the procedure from the README.md file.
 
 2. Make /usr/lib/interchange-5.x.x/interchange.cfg match your
 /usr/lib/interchange.cfg. Note that there may be new options; but the

diff --git a/configure b/configure
@@ -4,7 +4,7 @@ cat <<EOF
 
  Interchange
 
- Copyright 2002-2017 Interchange Development Group (http://www.icdevgroup.org/)
+ Copyright 2002-2018 Interchange Development Group (http://www.icdevgroup.org/)
  Copyright 1996-2002 Red Hat, Inc.
 
  Interchange was originally based on Vend 0.2 and 0.3