Commit d70f20b4 authored by Chris Woodall's avatar Chris Woodall
Browse files

Updated readme

parent af6fae71
Pipeline #3742 passed with stage
in 40 seconds
# objdict-generate.py
# objdict-generate: CanOpen Object Dictionary Generator
> `objdict-generate` is a Barrett utility for taking a YAML description of
> an object dictionary and generating an EDS, .h, .c, and other file
> information
## Dependencies
- PyYaml 3.12
- pykwalify: For validating the .yaml file against a schema.
- Arrow: A sane time library for python.
- Jinja2: A templating engine for python
**Build Status**: [![build status](https://git.barrett.com/burt/tools/objdict-generate/badges/devel/build.svg)](https://git.barrett.com/burt/tools/objdict-generate/commits/devel)
**Coverage Report**: [![coverage report](https://git.barrett.com/burt/software/burt-util/badges/devel/coverage.svg)](https://git.barrett.com/burt/tools/objdict-generate/commits/devel)
*Requires*: Python 3.4+
## Installing
Run the following command to install dependencies:
### Quick Start
The following commands are all you need:
```shell-session
$ sudo apt-get install -y python3 python3-pip
$ sudo pip3 install git+https://git.barrett.com/burt/tools/objdict-generate.git
```
$ cd scripts/objdict-generate
$ sudo pip3 install .
### Development Setup
First download the repository:
```shell-session
$ git clone https://git.barrett.com/burt/tools/objdict-generate.git && cd objdict-generate
```
Now `objdict_generate` will be installed on your platform
```shell-session
$ sudo apt-get install -y python3 python3-pip
```
All python requirements are managed by the setup.py file and the application can
be installed by running:
```shell-session
$ sudo ./setup.py install
```
To verified it is installed properly you can now run the unit tests:
```shell-session
$ sudo ./setup.py test
```
_Note_: Currently _virtualenv_ usage is broken.
## Dependencies
- PyYaml 3.12
- pykwalify: For validating the .yaml file against a schema.
- Arrow: A sane time library for python.
- Jinja2: A templating engine for python
## Usage:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment