README

   1 # Libtasn1 README -- Introduction information
   2
   3 This is GNU Libtasn1, a small ASN.1 library.
   4
   5 The C library (libtasn1.*) is licensed under the GNU Lesser General
   6 Public License version 2.1 or later.  See the file COPYING.LIB.
   7
   8 The command line tool, self tests, examples, and other auxilliary
   9 files, are licensed under the GNU General Public License version 3.0
  10 or later.  See the file COPYING.
  11
  12 ## Building the library
  13
  14 We require several tools to build the software, including:
  15
  16 * [Make](https://www.gnu.org/software/make/)
  17 * [Automake](https://www.gnu.org/software/automake/) (use 1.11.3 or later)
  18 * [Autoconf](https://www.gnu.org/software/autoconf/)
  19 * [Libtool](https://www.gnu.org/software/libtool/)
  20 * [Texinfo](https://www.gnu.org/software/texinfo/)
  21 * [help2man](http://www.gnu.org/software/help2man/)
  22 * [Tar](https://www.gnu.org/software/tar/)
  23 * [Gzip](https://www.gnu.org/software/gzip/)
  24 * [bison](https://www.gnu.org/software/bison/)
  25 * [Texlive & epsf](https://www.tug.org/texlive/) (for PDF manual)
  26 * [GTK-DOC](https://www.gtk.org/gtk-doc/) (for API manual)
  27 * [Git](https://git-scm.com/)
  28 * [libabigail](https://pagure.io/libabigail/) (for abi comparison in make dist)
  29 * [Valgrind](https://valgrind.org/) (optional)
  30
  31 The required software is typically distributed with your operating
  32 system, and the instructions for installing them differ.  Here are
  33 some hints:
  34
  35 Debian/Ubuntu:
  36 ```
  37 sudo apt-get install make git autoconf automake libtool bison
  38 sudo apt-get install texinfo help2man gtk-doc-tools valgrind abigail-tools
  39 ```
  40
  41 PDF manual - Debian <= stretch:
  42 ```
  43 sudo apt-get install texlive-generic-recommended texlive texlive-extra-utils
  44 ```
  45
  46 PDF manual - Debian >= buster:
  47 ```
  48 sudo apt-get install texlive-plain-generic texlive texlive-extra-utils
  49 ```
  50
  51 The next step is to run autoreconf, ./configure, etc:
  52
  53 ```
  54 $ ./bootstrap
  55 ```
  56
  57 Then build the project normally:
  58
  59 ```
  60 $ ./configure
  61 $ make check
  62 ```
  63
  64 Happy hacking!
  65
  66
  67 ## Manual
  68
  69 The manual is in the `doc/` directory of the release.
  70
  71 You can also browse the manual online at:
  72
  73  - https://www.gnu.org/software/libtasn1/manual/
  74  - https://gnutls.gitlab.io/libtasn1/manual/
  75  - https://gnutls.gitlab.io/libtasn1/manual/libtasn1.html
  76  - https://gnutls.gitlab.io/libtasn1/manual/libtasn1.pdf
  77  - https://gnutls.gitlab.io/libtasn1/reference/
  78  - https://gnutls.gitlab.io/libtasn1/reference/libtasn1.pdf
  79
  80
  81 ## Code coverage report
  82
  83 The coverage report is at:
  84
  85  - https://gnutls.gitlab.io/libtasn1/coverage
  86
  87
  88 ## Issue trackers
  89
  90  - [Main issue tracker](https://gitlab.com/gnutls/libtasn1/issues)
  91  - [oss-fuzz found issues](https://bugs.chromium.org/p/oss-fuzz/issues/list?q=libtasn1&can=2)
  92
  93
  94 ## Homepage
  95
  96 The project homepage at the gnu site is at:
  97
  98 https://www.gnu.org/software/libtasn1/