INSTALL.md

   1
   2 ## Compiling From Sources
   3
   4 ### Configure
   5
   6 See [REQUIREMENTS.md](REQUIREMENTS.md) for the complete list of dependencies.
   7
   8 Configure with the default settings:
   9
  10     autoreconf -iv
  11     ./configure
  12     make
  13
  14 Configure with non-standard settings:
  15
  16 asn1c-specific ./configure options include:
  17
  18   Option                 | Description
  19 ------------------------ | ---------------------------------------------------
  20   --enable-ASN_DEBUG     | produce debug log during `make check` testing
  21   --enable-code-coverage | whether to enable code coverage support
  22   --enable-Werror        | abort compilation after any C compiler warning
  23   --enable-test-Werror   | abort compiling tests after any C compiler warning
  24   --enable-test-32bit    | enable tests for 32-bit compatibility
  25   --disable-test-ubsan   | disable Undefined Behavior Sanitizer for tests
  26   --disable-test-asan    | disable Address Sanitizer for tests
  27   --enable-test-fuzzer   | enable LLVM LibFuzzer for randomized testing
  28
  29 invoke `./configure --help` for details.
  30
  31 ### Build
  32
  33 Build the libraries and the compiler:
  34
  35     make
  36
  37 Ensure asn1c is still behaving well after compiling on your platform:
  38
  39     make check
  40
  41 ### Install
  42
  43 Install the compiler into a standard location:
  44
  45     make install
  46     # Use ./configure --prefix to override install location.
  47
  48 Display the `asn1c` manual page:
  49
  50     man asn1c
  51
  52 ## Quick Usage Guide
  53
  54 For a usage guide and more information please refer to:
  55
  56  * the [README.md](README.md) file
  57  * the asn1c manual page `man asn1c`
  58  * the included quick start PDF [doc/asn1c-quick.pdf](doc/asn1c-quick.pdf)
  59  * the comprehensive usage documentation [doc/asn1c-usage.pdf](doc/asn1c-usage.pdf)
  60
  61 In case of any difficulties with installing the compiler, consider using
  62 the Online ASN.1 Compiler at http://lionet.info/asn1c.
  63
  64 --
  65 Lev Walkin
  66 vlm@lionet.info