summaryrefslogtreecommitdiff
path: root/contrib/chem/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/chem/README.txt')
-rw-r--r--contrib/chem/README.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/contrib/chem/README.txt b/contrib/chem/README.txt
new file mode 100644
index 00000000..25518453
--- /dev/null
+++ b/contrib/chem/README.txt
@@ -0,0 +1,52 @@
+`chem' is a `roff' language to generate chemical structure diagrams.
+`@g@chem' is a `groff' preprocessor that produces output suitable for
+the `@g@pic' preprocessor.
+
+The original version of `chem' is an `awk' script written by Brian
+Kernighan <http://cm.bell-labs.com/cm/cs/who/bwk/index.html>. The
+source files of the `awk' version of `chem' are available at
+<http://cm.bell-labs.com/netlib/typesetting/chem.gz>.
+
+This project is a rewrite of `chem' in Perl for the GNU `roff' project
+`groff'. It was written under Perl v5.8.8, but at least Perl v5.6 is
+needed to run the Perl version of `chem'.
+
+In comparison to the original `awk' version of `chem', the Perl
+version does the following changements:
+- the options -h, --help, -v, --version to output usage and version
+information are added.
+- remove some functions `inline', `shiftfields', and `set' and some
+variables that are used only once.
+
+The subdirectory `examples/' contains example files for chem. They
+are written in the `chem' language. The file names end with .chem.
+
+
+####### License
+
+Last update: 5 Jan 2009
+
+Copyright (C) 2006, 2009 Free Software Foundation, Inc.
+Written by Bernd Warken <groff-bernd.warken-72@web.de>.
+
+This file is part of `chem', which is part of `groff'.
+
+`groff' is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+`groff' is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+####### Emacs settings
+
+Local Variables:
+mode: text
+End: