Getting ready for Releasing the Crate.

Moved the Test cases for RANAP, S1AP and NGAP inside the `examples/`
directory. Updated the README.

Author: gabhijit

Cargo.toml

@@ -3,4 +3,5 @@ members = [
 	"asn-compiler",
 	"codecs",
 	"codecs_derive",
+	"examples",
 ]

README.md

@@ -2,12 +2,22 @@
 
 The Goal of this project is to implement an ASN.1 Compiler in Rust which can generate Rust bindings for different ASN.1 specifications, which can be used in those protocol implementations in Rust.
 
-Currently the focus is on working with 3GPP protocols for 5G, more specifically Core Network protocols like NGAP.
+This project is divided into three crates -
+
+1. asn1-compiler: This crate provides the actual ASN.1 Compiler.
+2. asn-codecs: Support for different encodings supported by individual ASN.1 specifications is provided in this crate. Currently only APER Codec is supported. Each Codec is supported as a `trait` implementing `encode` and `decode` functions.
+3. asn-codecs-derive: This crate provides the `derive` macros for the codecs in `asn-codecs`. The code generated using `asn-compiler` can be directed to `derive` appropriate codecs by passing the flags during compilation.
 
 ## Status
 
-Right now specifications in the `specs/` directory can be parsed correctly(hopefully!) into an AST for the ASN.1 module definitions. This is in active development there are no public APIs at this time.
+Currently specifications from the `specs/` directory can be compiled into respective Rust modules. See below for how these Rust modules can be used.
 
 ## Getting Started
 
-Test cases can be run through `cargo test`. Or one can checkout the AST for the protocols using `cargo run specs/ngap/*asn`.
+### Running Test Cases
+
+1. Test cases can be run through `cargo test`.
+2. Right now `examples/` directory contains simple `decode` test cases for modules generated using the `asn-compiler`. This support will be improved to include the generated modules using mechanisms like `build.rs`.
+
+
+

codecs_derive/Cargo.toml

@@ -1,8 +1,10 @@
 [package]
 name = "asn_codecs_derive"
+authors = ["Abhijit Gadgil <[email protected]>"]
 version = "0.1.0"
 edition = "2018"
 
+
 [lib]
 proc-macro = true
 

codecs_derive/tests/compile.rs

@@ -12,8 +12,4 @@ fn tests() {
     t.pass("tests/08-seq.rs");
     t.pass("tests/09-open.rs");
     t.pass("tests/10-seqof.rs");
-    // TODO: When we can parse all the three specs enable these.
-    // t.pass("tests/11-ranap.rs");
-    // t.pass("tests/12-s1ap.rs");
-    // t.pass("tests/13-ngap.rs");
 }

examples/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "hampi-examples"
+version = "0.0.0"
+authors = ["Abhijit Gadgil <[email protected]>"]
+edition = "2018"
+publish = false
+
+
+[dev-dependencies]
+asn-codecs = { path = "../codecs" }
+asn_codecs_derive = { path = "../codecs_derive" }
+trybuild = { version = "1.0" }
+hex = "*"
+bitvec = { version = "0.22" }