osmocom
/
asn1c
mirror of https://gerrit.osmocom.org/asn1c
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

INSTALL -> INSTALL.md

This commit is contained in:
Lev Walkin 2016-08-02 04:03:03 -07:00
parent 93ed494210
commit 83b52d8fdb
3 changed files with 61 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
INSTALL
View File

@ -1,51 +0,0 @@
QUICK START INSTALLATION
========================
./configure
(or `autoreconf -iv && ./configure` if you've got asn1c
straight from github).
Configure the build infrastructure for your platform
asn1c specific ./configure options include:
--enable-Werror
--enable-ASN_DEBUG
invoke `./configure --help` for details.
make
Build the libraries and the compiler.
make check
Ensure asn1c is still behaving well after compiling on your platform.
PLEASE CONTACT ME IF THIS STEP FAILS! Lev Walkin <vlm@lionet.info>
make install
Install the compiler into a standard location.
Use ./configure --prefix to override install location.
man asn1c
Display the asn1c manual page.
QUICK USAGE GUIDE
=================
For usage guide and more information please refer to:
* the ./README.md file.
* the asn1c manual page `man asn1c`
* the included quick start PDF doc/asn1c-quick.pdf
* the comprehensive usage documentation doc/asn1c-usage.pdf
In case of any difficulties with installing the compiler, consider using
the Online ASN.1 Compiler at
http://lionet.info/asn1c
--
Lev Walkin
vlm@lionet.info

56
INSTALL.md Normal file
View File

@ -0,0 +1,56 @@
## QUICK START INSTALLATION
### Configure
**Configure with the default settings:**
test -f configure || autoreconf -iv
./configure
make
**Configure with non-standard settings:**
asn1c specific ./configure options include:
--enable-Werror
--enable-ASN_DEBUG
invoke `./configure --help` for details.
### Build
Build the libraries and the compiler:
make
Ensure asn1c is still behaving well after compiling on your platform:
make check
### Install
**Install the compiler into a standard location:**
make install
# Use ./configure --prefix to override install location.
**Display the `asn1c` manual page:**
man asn1c
## QUICK USAGE GUIDE
For usage guide and more information please refer to:
* the ./README.md file.
* the asn1c manual page `man asn1c`
* the included quick start PDF doc/asn1c-quick.pdf
* the comprehensive usage documentation doc/asn1c-usage.pdf
In case of any difficulties with installing the compiler, consider using
the Online ASN.1 Compiler at
http://lionet.info/asn1c
--
Lev Walkin
vlm@lionet.info

8
README.md
View File

@ -16,8 +16,10 @@ ASN.1 compiler.
# Build and Install
If you haven't installed the asn1c yet, read the [INSTALL](INSTALL) file for a
short installation guide.
If you haven't installed the asn1c yet, read the [INSTALL.md](INSTALL.md) file
for a short installation guide.
[![Build Status](https://travis-ci.org/vlm/asn1c.svg?branch=master)](https://travis-ci.org/vlm/asn1c)
# Documentation
@ -34,7 +36,7 @@ An excellent book on ASN.1 is written by Olivier Dubuisson:
(also check out [doc/asn1c-quick.pdf](doc/asn1c-quick.pdf))
After installing the compiler (see [INSTALL](INSTALL)), you may use
After installing the compiler (see [INSTALL.md](INSTALL.md)), you may use
the asn1c command to compile the ASN.1 specification:
asn1c <module.asn1> # Compile module