← Back to branch summary

~elementary-os/elementaryos/distinst

« back to all changes in this revision

Viewing changes to vendor/moz-cheddar/README.tpl

  • Committer: Jeremy Soller
  • Author(s): Jeremy Soller
  • Date: 2017-09-20 20:04:24 UTC
  • Revision ID: git-v1:d86866a0ba910af7cd2228925f46004c13a3edce
Add vendor files

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/moz-cheddar/README.tpl
 
1
**_This is a fork of rusty-cheddar until such time as
 
2
the [rusty-binder version](https://gitlab.com/rusty-binder/rusty-cheddar)
 
3
is available._**
 
4
 
 
5
# {{crate}}
 
6
 
 
7
[![Build Status](https://travis-ci.org/mozilla/moz-cheddar.svg?branch=master)](https://travis-ci.org/mozilla/moz-cheddar)
 
8
[![crates.io](http://meritbadge.herokuapp.com/moz-cheddar)](https://crates.io/crates/moz-cheddar)
 
9
![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)
 
10
 
 
11
{{readme}}
 
12
 
 
13
## Contributing
 
14
 
 
15
Contributions to moz-cheddar are more than welcome.
 
16
 
 
17
### Bugs
 
18
 
 
19
If you find a bug or have a feature request please open an issue.
 
20
 
 
21
If you find the source code unclear in any way then I consider that a bug.
 
22
I try to make my source code as clear as possible, so any help in that
 
23
regard is appreciated.
 
24
 
 
25
Pull requests are also welcome, of course.
 
26
 
 
27
### Tests
 
28
 
 
29
The tests require you to have a version (> `v2.7.2`) of [CppHeaderParser]
 
30
installed for the version of Python which is installed as `python`
 
31
(usually Python 2). Furthermore, due to the fact that the tests are a
 
32
massive pile of wanky hacks, you must be in the same directory as
 
33
moz-cheddar's `Cargo.toml` to successfully run them.
 
34
 
 
35
If you don't have this, try
 
36
```bash
 
37
pip install CppHeaderParser
 
38
```
 
39
 
 
40
[rusty-binder]: https://gitlab.com/rusty-binder/rusty-binder
 
41
[these docs]: http://manishearth.github.io/rust-internals-docs/syntax/ast/index.html
 
42
[CppHeaderParser]: https://bitbucket.org/senex/cppheaderparser