Split CONTRIBUTING from README

Author: Pascal Hertleif

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Development
+
+Thanks for looking into contributing to this project!
+
+## Quick overview
+
+```bash
+# generate messages.rs to look at results
+cargo run -p dbc-codegen-cli -- testing/dbc-examples/example.dbc testing/can-messages/src
+
+# build everything
+cargo build --all
+
+# run all tests
+cargo test --all
+
+# format before committing anything
+cargo fmt --all
+```
+
+## Testing setup
+
+Please refer to the [testing README file](./testing/README.adoc)
+
+## Generate .kdc from .dbc
+
+Use [canmatrix](https://github.com/ebroecker/canmatrix) if you need to generate a new `.kcd` file from a `.dbc`.
+
+```bash
+# https://canmatrix.readthedocs.io/en/latest/installation.html
+pip install canmatrix
+pip install git+https://github.com/ebroecker/canmatrix#egg=canmatrix[kcd]
+
+# generate .kcd
+canconvert testing/dbc-examples/example.dbc testing/dbc-examples/example.kcd
+```

README.md

@@ -4,20 +4,34 @@ Generates Rust messages from a `dbc` file.
 
 ⚠️ This is experimental - use with caution. Breaking changes will happen when you least expect it. ⚠️
 
+## Installation
+
+With cargo:
+
+```bash
+cargo install dbc-codegen --git https://github.com/technocreatives/dbc-codegen --branch main
+```
+
 ## Usage
 
-Generate `messages.rs` from `example.dbc`.
+Generate `messages.rs` from `example.dbc`:
+
 ```bash
-cargo run -- testing/dbc-examples/example.dbc dir/where/messages_rs/file/is/written
+dbc-codegen testing/dbc-examples/example.dbc dir/where/messages_rs/file/is/written
 ```
 
-If some field name starts with a non-alphabetic character or is a Rust keyword then it is prepended with `x`.
+### Field/variant rename rules
+
+If some field name starts with a non-alphabetic character or is a Rust keyword then it is prefixed with `x`.
 
 For example:
+
 ```
 VAL_ 512 Five 0 "0Off" 1 "1On" 2 "2Oner" 3 "3Onest";
 ```
-..is generated to:
+
+…is generated as:
+
 ```rust
 pub enum BarFive {
     X0off,
@@ -29,10 +43,13 @@ pub enum BarFive {
 ```
 
 `Type` here:
+
 ```
 SG_ Type : 30|1@0+ (1,0) [0|1] "boolean" Dolor
 ```
-..would become Rust keyword `type` therefore it is prepended with `x`:
+
+…conflicts with the Rust keyword `type`. Therefore we prefix it with `x`:
+
 ```rust
 pub fn xtype(&self) -> BarType {
     match self.xtype_raw() {
@@ -43,31 +60,18 @@ pub fn xtype(&self) -> BarType {
 }
 ```
 
-## Development
-
-```bash
-# generate messages.rs
-cargo run -- testing/dbc-examples/example.dbc testing/can-messages/src
-
-# build all binaries
-cargo build --all
+## License
 
-# run all tests
-cargo test --all
+Licensed under either of
 
-# format before commiting anything
-cargo fmt --all
-```
+ - Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
 
-### Generate .kdc from .dbc
+at your option.
 
-Use [canmatrix](https://github.com/ebroecker/canmatrix) if you need to generate a new `.kcd` file from a `.dbc`.
+### Contribution
 
-```bash
-# https://canmatrix.readthedocs.io/en/latest/installation.html
-pip install canmatrix
-pip install git+https://github.com/ebroecker/canmatrix#egg=canmatrix[kcd]
-
-# generate .kcd
-canconvert testing/dbc-examples/example.dbc testing/dbc-examples/example.kcd
-```
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the Apache-2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.