README

XXXgen
=======

XXXgen is a tool to randomly generate fake papers, depending on the input rules.

The mathgen rule files are provided for convenience.

Source code (Github): https://github.com/moshbear/mathgen

Running
=======

The main XXXgen program is `xxxgen.py'.

Run
$ python xxxgen.py < RULE_FILE 
or
$ python xxxgen.py RULE_FILE

Output is standard output. Writing to file can be implemented with two or so lines of code.

Explicitly specifying authors is unimplemented.

Source code
===========

A quick road map to the files in the source distribution:

- xxxgen.py: Main driver file, processes options and disposes of
  output.

- xxxgen/lib.py: The SCIgen grammar engine.  Reads the rules files and
  generates the output.

- scirules.in: Common grammar rules, included into the following
  files.

- sci{article,book,blurb}.in: Grammar rules specific for the
  corresponding products.


Credits
=======

Credit is given to Mathgen and SCIgen, and their authors:
- Nate Eldredge <nate at thatsmathematics dot com>,
- SCIgen (https://pdos.csail.mit.edu/scigen/): Jeremy Stribling, Max Krohn, and Dan Aguayo

For the mathgen rule files provided by mathgen:
A list of names of famous mathematicians, used in the program, was
extracted from the web site The Greatest Mathematicians of All Time
(https://fabpedigree.com/james/greatmm.htm) by James Dow Allen, and is
used by permission. A list of countries and other place names was
taken from Wikipedia
(https://en.wikipedia.org/wiki/List_of_adjectival_and_demonymic_forms_of_place_names)


License
=======

XXXgen is free software.  You are welcome to share, copy, and modify
it, under the terms of the GNU General Public License, version 2.0.
See the file COPYING.