doc/README

   1
   2 #########################################################
   3 # LINUX Compile this documentation in-place procedure
   4 # to get ready-to-read documentation when
   5 # user just done 'git-clone' SAT
   6 #########################################################
   7
   8 # prerequisites:
   9 # needs sphinx-build to make doc html
  10 # needs texlive up-to-date to make doc pdf
  11
  12 # make doc html
  13 cd doc
  14 make html
  15 firefox build/html/index.html &
  16
  17 # to make doc pdf without error
  18 # user needs texlive up-to-date
  19 # see https://www.tug.org/texlive/quickinstall.html
  20
  21 # on machines Centos7 dm2s/lgls as x86_64-linux his is not good,
  22 # see https://www.centos.org/forums/viewtopic.php?t=54410
  23 # so user simply have to set PATH on one correct texlive package
  24 # compiled here:
  25
  26 # export INFOPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/info
  27 # export MANPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/man
  28 # export PATH=/data/tmplgls/wambeke/share/texlive/2017/bin/x86_64-linux:${PATH}
  29 # and then ...
  30
  31
  32 # make doc pdf
  33 cd doc
  34 make latexpdf
  35 evince build/latex/sat.pdf &
  36