forked from Sean1708/rusty-cheddar
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.tpl
40 lines (27 loc) · 1.74 KB
/
README.tpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
**_Please be aware that version `v0.4.0` of rusty-cheddar will be based around the more general
[rusty-binder] framework, though this is still work in progress._**
# {{crate}}
[](https://travis-ci.org/Sean1708/rusty-cheddar)
[](https://crates.io/crates/rusty-cheddar)
{{readme}}
## Contributing
Contributions to rusty-cheddar are more than welcome.
### Bugs
If you find a bug or have a feature request please open an issue. I can't guarantee that I'll fix it
but I'll give it a damn good go.
If you find the source code unclear in any way then I consider that a bug. I try to make my source
code as clear as possible but I'm not very good at it, so any help in that regard is appreciated.
### PRs
I love pull requests they tend to make my job much easier, so if you want to fix a bug or implement
a feature yourself then that would be great. If you're confused by anything or need some pointers on
how to proceed then feel free to open an issue so that I can help, otherwise [these docs] are a good
place to start.
#### Tests
The tests require you to have a recent version (> `v2.7.2`) of [CppHeaderParser] installed for the
version of Python which is installed as `python` (usually Python 2). Furthermore due to the fact
that the tests are a massive pile of wanky hacks, you must be in the same directory as
rusty-cheddar's `Cargo.toml` to successfully run them.
[rusty-binder]: https://gitlab.com/rusty-binder/rusty-binder
[these docs]: http://manishearth.github.io/rust-internals-docs/syntax/ast/index.html
[CppHeaderParser]: https://bitbucket.org/senex/cppheaderparser