README

NEATROFF TOP-LEVEL MAKEFILE
===========================

This directory contains the top-level Makefile of Neatroff to obtain
and build Neatroff and the helper programs that accompany it.

To use Neatroff without installing it (which is recommended), execute
the following commands (which obtain a few commonly used fonts
automatically for convenience):

$ make init		# Obtain the necessary files and fonts
$ make neat		# Build the programs

To create Farsi documents, replace the first command with the
following:

$ make init_fa

The demo directory contains a sample Neatroff document:

$ cd demo		# A small neatroff test
$ make			# Generate test.pdf from test.ms

To add fonts, copy them to the fonts directory and rebuild the
neat target.  In Neatroff, fonts/MyFont.ttf can be mounted as
follows:

  .fp - R MyFont

For more information, consult the following documents:

http://litcave.rudi.ir/neatstart.pdf
http://litcave.rudi.ir/neatfbeg.pdf

LICENCE
=======

Except for the tmac/ directory (see tmac/NOTICE) everything in this
directory are released under the following terms (the ISC licence):

NEATROFF TYPESETTING SYSTEM

Copyright (C) 2012-2020 Ali Gholami Rudi <ali at rudi dot ir>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.