frosix

Multiparty signature service (experimental)
Log | Files | Refs | README | LICENSE

README (1642B)


      1 This directory contains the terms of service (template) for exchange
      2 operators.
      3 
      4 
      5 Dependencies
      6 ============
      7 
      8 Generating new Terms of Service requires Sphinx, LaTeX with babel
      9 packages for all supported languages.  On Debian, you should
     10 at least install:
     11 
     12 $ apt install python3-sphinx sphinx-intl texlive-lang-german texlive-lang-english
     13 
     14 (NOTE: List may be incomplete.)
     15 
     16 
     17 Updating the Terms of Service
     18 =============================
     19 
     20 The master file with the Terms of service is 'tos.rst'.
     21 
     22 If you make substantial changes, you MUST change the "TOS_VERSION"
     23 in contrib/Makefile.am to the new Etag.
     24 
     25 To begin the translation into other languages after editing the master
     26 file, run
     27 
     28 $ make gettext
     29 
     30 to generate the master PO file. Then, run
     31 
     32 $ sphinx-intl update -p _build/locale/ -l de -l fr -l it
     33 
     34 to update the PO files for the various languages (extend the list of
     35 languages as necessary). The PO files for the translators are kept
     36 at locale/$LANG/LC_MESSAGES/tos.po for the language $LANG.
     37 
     38 Once all PO files have been updated with new translations, run
     39 
     40 $ make update-tos
     41 
     42 in the "contrib/" directory to generate all of the formats.  The
     43 respective make rule calls the '../update-tos.sh' script in the
     44 contrib/ directory, which calls the 'Makefile' in the tos/
     45 directory for the various supported languages and file formats
     46 and then moves the generated files to the target directory
     47 ('contrib/tos/$LANG/$VERSION.$FORMAT')
     48 
     49 
     50 Adding a new language
     51 =====================
     52 
     53 To add a new language $LANG, add $LANG to "TOS_LANGUAGES" in
     54 'contrib/Makefile.am' and run
     55 
     56 $ sphinx-intl update -p _build/gettext -l $LANG
     57 
     58 to generate the PO template.