README

   1 NEATROFF TOP-LEVEL MAKEFILE
   2 ===========================
   3
   4 This directory contains the top-level Makefile of Neatroff to obtain
   5 and build Neatroff and the helper programs that accompany it.
   6
   7 To use Neatroff without installing it (which is recommended), execute
   8 the following commands (which obtain a few commonly used fonts
   9 automatically for convenience):
  10
  11 $ make init             # Obtain the necessary files and fonts
  12 $ make neat             # Build the programs
  13
  14 To create Farsi documents, replace the first command with the
  15 following:
  16
  17 $ make init_fa
  18
  19 The demo directory contains a sample Neatroff document:
  20
  21 $ cd demo               # A small neatroff test
  22 $ make                  # Generate test.pdf from test.ms
  23
  24 To add fonts, copy them to the fonts directory and rebuild the
  25 neat target.  In Neatroff, fonts/MyFont.ttf can be mounted as
  26 follows:
  27
  28   .fp - R MyFont
  29
  30 For more information, consult the following documents:
  31
  32 http://litcave.rudi.ir/neatstart.pdf
  33 http://litcave.rudi.ir/neatfbeg.pdf
  34
  35 LICENCE
  36 =======
  37
  38 Except for the tmac/ directory (see tmac/NOTICE) everything in this
  39 directory are released under the following terms (the ISC licence):
  40
  41 NEATROFF TYPESETTING SYSTEM
  42
  43 Copyright (C) 2012-2020 Ali Gholami Rudi <ali at rudi dot ir>
  44
  45 Permission to use, copy, modify, and/or distribute this software for any
  46 purpose with or without fee is hereby granted, provided that the above
  47 copyright notice and this permission notice appear in all copies.
  48
  49 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  50 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  51 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  52 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  53 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  54 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  55 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.