README.md

   1 |Branch|CI system|Status|
   2 |:----:|:-------:|-----:|
   3 |Master|Gitlab|[![build status](https://gitlab.com/gnutls/libtasn1/badges/master/build.svg)](https://gitlab.com/gnutls/libtasn1/commits/master)[![coverage report](https://gitlab.com/gnutls/libtasn1/badges/master/coverage.svg)](https://gnutls.gitlab.io/libtasn1/coverage)|
   4
   5 # libtasn1
   6
   7 This is GNU Libtasn1, a small ASN.1 library.
   8
   9 The C library (libtasn1.*) is licensed under the GNU Lesser General
  10 Public License version 2.1 or later.  See the file COPYING.LIB.
  11
  12 The command line tool, self tests, examples, and other auxilliary
  13 files, are licensed under the GNU General Public License version 3.0
  14 or later.  See the file COPYING.
  15
  16 ## Building the library
  17
  18 We require several tools to build the software, including:
  19
  20 * [Make](https://www.gnu.org/software/make/)
  21 * [Automake](https://www.gnu.org/software/automake/) (use 1.11.3 or later)
  22 * [Autoconf](https://www.gnu.org/software/autoconf/)
  23 * [Libtool](https://www.gnu.org/software/libtool/)
  24 * [Texinfo](https://www.gnu.org/software/texinfo/)
  25 * [help2man](http://www.gnu.org/software/help2man/)
  26 * [Tar](https://www.gnu.org/software/tar/)
  27 * [Gzip](https://www.gnu.org/software/gzip/)
  28 * [bison](https://www.gnu.org/software/bison/)
  29 * [Texlive & epsf](https://www.tug.org/texlive/) (for PDF manual)
  30 * [GTK-DOC](https://www.gtk.org/gtk-doc/) (for API manual)
  31 * [Git](https://git-scm.com/)
  32 * [libabigail](https://pagure.io/libabigail/) (for abi comparison in make dist)
  33 * [Valgrind](https://valgrind.org/) (optional)
  34
  35 The required software is typically distributed with your operating
  36 system, and the instructions for installing them differ.  Here are
  37 some hints:
  38
  39 gNewSense/Debian/Ubuntu:
  40 ```
  41 sudo apt-get install make git-core autoconf automake libtool
  42 sudo apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
  43 sudo apt-get install help2man gtk-doc-tools valgrind abigail-tools
  44 ```
  45
  46 The next step is to run autoreconf, ./configure, etc:
  47
  48 ```
  49 $ ./bootstrap
  50 ```
  51
  52 Then build the project normally:
  53
  54 ```
  55 $ make
  56 $ make check
  57 ```
  58
  59 Happy hacking!
  60
  61
  62 ## Manual
  63
  64 The manual is in the `doc/` directory of the release.  You can also browse
  65 the manual online at:
  66
  67  - https://gnutls.gitlab.io/libtasn1/
  68
  69
  70 ## Code coverage report
  71
  72 The coverage report is at:
  73
  74  - https://gnutls.gitlab.io/libtasn1/coverage
  75
  76
  77 ## Homepage
  78
  79 The project homepage at the gnu site is at:
  80
  81 http://www.gnu.org/software/libtasn1/
  82
  83
  84 For any copyright year range specified as YYYY-ZZZZ in this package
  85 note that the range specifies every single year in that closed interval.