README

   1 This is client library for accessing SOAP services of ISDS (Informační systém
   2 datových schránek / Data Box Information System) as defined in Czech ISDS Act
   3 (300/2008 Coll.) <http://portal.gov.cz/zakon/300/2008> and implied documents.
   4
   5 Copyright (C) 2009, 2010, 2011, 2012, 2013  Petr Písař <petr.pisar@atlas.cz>
   6 Copyright (C) 2014, 2015, 2016  Petr Písař <petr.pisar@atlas.cz>
   7
   8 This program is free software: you can redistribute it and/or modify it under
   9 the terms of the GNU Lesser General Public License as published by the Free
  10 Software Foundation, either version 3 of the License, or (at your option) any
  11 later version.
  12
  13 This program is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  16 details.
  17
  18
  19 This code is written in ISO99 C language and requires libxml2, (optional but
  20 strongly recommended) cURL, (libgcrypt and GPGME) or OpenSSL, >=expat-2.0.0,
  21 xsltproc and DocBook XSLT stylesheets if building documentation is enabled,
  22 and (if not part of your standard library) optional Gettext libraries and
  23 pkg-config tool at compilation time. gnupg2 is required at run time (provides
  24 gpgsm that uses gpgme to process CMS) if GPGME cryptographic back-end is
  25 selected. Build system preparation from VCS requires >=automake-1.11,
  26 autoconf, autopoint, and libtool in addition. Tests require >=GnuTLS-2.12.0
  27 library.
  28
  29 Applications linked against this library need to be linked to libxml2 too.
  30
  31 It has been tested on GNU/Linux (Linux 3.18.2, glibc-2.19, gcc-4.8.3) with
  32 libxml2-2.9.2, curl-7.39.0, libgcrypt-1.5.4, gpgme-1.3.2, expat-2.1.0,
  33 gnupg-2.0.26, and gnutls-3.3.11 on amd64 architecture.
  34
  35 Latest code can be obtained from GIT repository
  36 <http://repo.or.cz/w/libisds.git> (web interface).
  37
  38 ISDS documentation is located under `doc' directory, user documentation can be
  39 found in header files. See `client' directory for examples how to use this
  40 library. Preliminary library self-tests are located in `test' directory. Test
  41 data and message examples are stored in `server/messages' directory.
  42
  43 Credentials for testing account can be passed to example clients and on-line
  44 tests by environmental variables `ISDS_USERNAME' and `ISDS_PASSWORD' or by
  45 saving them into `test_credentials' in build root directory (first line is
  46 user name, second line is password). Environmental variables take precedence.