[interchange] Convert README to Markdown for nice GitHub viewing
Jon Jensen <[email protected]> Tue, 15 May 2018 04:58:27 +0000
| Newsgroups | gmane.comp.web.interchange.cvs |
|---|---|
| Message-ID | <[email protected]> |
--===============0846712920== Content-Type: text/plain commit 027f3dfdaebc380053c94c9694a11302bf504929 Author: Jon Jensen <[email protected]> Date: Mon May 14 22:56:31 2018 -0600 Convert README to Markdown for nice GitHub viewing As suggested in GitHub issue #99. Along the way, update some things that needed it. MANIFEST | 2 +- Makefile.PL | 2 +- README | 174 ---------------------------------------------- README.md | 177 +++++++++++++++++++++++++++++++++++++++++++++++ SPECS/interchange.spec | 2 +- UPGRADE | 2 +- configure | 2 +- debian/interchange.docs | 2 +- scripts/interchange.PL | 16 ++-- test.pl | 2 +- 10 files changed, 192 insertions(+), 189 deletions(-) --- diff --git a/MANIFEST b/MANIFEST index ca81e91..c0f79ea 100644 --- 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 index 4a9181d..08dd4ee 100644 --- 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.md b/README.md new file mode 100644 index 0000000..686318b --- /dev/null +++ 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 index 649f5a6..093c6a4 100644 --- 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 index 2740d87..2a1fc34 100644 --- 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 index d45e7ff..58d914d 100755 --- 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 diff --git a/debian/interchange.docs b/debian/interchange.docs index b6482b5..960e531 100644 --- a/debian/interchange.docs +++ b/debian/interchange.docs @@ -1,4 +1,4 @@ -README +README.md README-DEVELOPMENT UPGRADE WHATSNEW-4.5 diff --git a/scripts/interchange.PL b/scripts/interchange.PL index fcd6dfe..6c195bb 100644 --- a/scripts/interchange.PL +++ b/scripts/interchange.PL @@ -3,14 +3,14 @@ # #-# Interchange version ~_~VERSION~_~ # -# Copyright (C) 2002-2017 Interchange Development Group +# Copyright (C) 2002-2018 Interchange Development Group # Copyright (C) 1996-2002 Red Hat, Inc. # http://www.icdevgroup.org/ # # This program was originally based on Vend 0.2 and 0.3 # Copyright 1995 by Andrew M. Wilcox <[email protected]> # -# See the files 'README' and 'WHATSNEW' for information. +# See the files 'README.md' and 'WHATSNEW' for information. # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -350,7 +350,7 @@ sub dontwarn { } sub version { - print "Interchange version $VERSION copyright 2002-2017 Interchange Development Group and others.\n"; + print "Interchange version $VERSION copyright 2002-2018 Interchange Development Group and others.\n"; } =head1 NAME @@ -990,7 +990,7 @@ GNU General Public License. =head1 COPYRIGHT - Copyright (C) 2002-2017 Interchange Development Group + Copyright (C) 2002-2018 Interchange Development Group Copyright (C) 1995-2002 Red Hat, Inc. All rights reserved except those granted in the license. @@ -1002,7 +1002,6 @@ Mike Heins is the primary author of Interchange. The Interchange Development Group is: - Daniel Browning David Christensen Gert van der Spoel Greg Hanson @@ -1037,6 +1036,7 @@ portions from Vend 0.3; both were produced in 1995. Special thanks to Retired Core Team Members: Brev Patterson + Daniel Browning David Kelly Davor Ocelic Ed LaFrance @@ -1061,7 +1061,7 @@ Contributions to Interchange have been made by: Andreas Koenig Jordan Adler Andrew Rich Josh Braegger Bill Carr Josh Lavin - Bill Dawkins José Mª Revuelto + Bill Dawkins José Mª Revuelto Bill Randle Jurgen Botz Birgitt Funk Justin Otten Bob Jordan Kaare Rasmussen @@ -1092,12 +1092,12 @@ Contributions to Interchange have been made by: Frank Bonita Raj Goel Frederic Steinfels Ray Desjardins Gary Benson Reid Sutherland - Gunnar Hellekson René Hertell + Gunnar Hellekson René Hertell Hamish Bradick Ryan Perry Hans-Joachim Leidinger Sergiusz Jarczyk Heinz Wittenbecher Shozo Murahashi Hiroyuki Cozy Kojima Sonny Cook - Ignacio Lizarán Spencer Christensen + Ignacio Lizarán Spencer Christensen Ivan Kohler Steve Graham Jack Tsai Thomas J.M. Burton Jason Holt Tim Baverstock diff --git a/test.pl b/test.pl index 801a8a6..d105014 100644 --- a/test.pl +++ b/test.pl @@ -1,6 +1,6 @@ # test.pl - Interchange test script # -# Copyright (C) 2002-2017 Interchange Development Group +# Copyright (C) 2002-2018 Interchange Development Group # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by --===============0846712920== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ interchange-cvs mailing list [email protected] http://www.icdevgroup.org/mailman/listinfo/interchange-cvs --===============0846712920==--