X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2FREADME;h=b412c82e75a6da6adf5b04d2d2186d99f7780e94;hb=4f11faf94fda002a0d2f6eed6aaf87518b505f69;hp=f5ccaa700fc0b2c96ee9c7c2899e186e9dbf372b;hpb=44cba357e75aeb717f1b0f0360722703766a2b0e;p=tools%2Fsat.git diff --git a/doc/README b/doc/README index f5ccaa7..b412c82 100644 --- a/doc/README +++ b/doc/README @@ -1,19 +1,35 @@ -# needs sphinx-build -# to make doc html +######################################################### +# LINUX Compile this documentation in-place procedure +# to get ready-to-read documentation when +# user just done 'git-clone' SAT +######################################################### +# prerequisites: +# needs sphinx-build to make doc html +# needs texlive up-to-date to make doc pdf + +# make doc html cd doc make html firefox build/html/index.html & -# to make doc pdf -# needs texlive a jour (done on machines lgls for x86_64-linux) -# https://www.tug.org/texlive/quickinstall.html +# to make doc pdf without error +# user needs texlive up-to-date +# see https://www.tug.org/texlive/quickinstall.html + +# on machines Centos7 dm2s/lgls as x86_64-linux his is not good, +# see https://www.centos.org/forums/viewtopic.php?t=54410 +# so user simply have to set PATH on one correct texlive package +# compiled here: + +# export INFOPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/info +# export MANPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/man +# export PATH=/data/tmplgls/wambeke/share/texlive/2017/bin/x86_64-linux:${PATH} +# and then ... -export INFOPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/info -export MANPATH=/data/tmplgls/wambeke/share/texlive/2017/texmf-dist/doc/man -export PATH=/data/tmplgls/wambeke/share/texlive/2017/bin/x86_64-linux:${PATH} +# make doc pdf cd doc make latexpdf evince build/latex/salomeTools.pdf &