Merge pull request #3 from progsource/add-run-test-help

added howto for running the tests
This commit is contained in:
Petra Baranski 2017-12-30 03:42:03 +01:00 committed by GitHub
commit d300d3a92a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -27,7 +27,7 @@ fitting my needs. So I simply wrote my own one.
The supported syntax can be found in the [definitions docs](docs/definitions.md).
## HowTo use
## How to use
To use maddy in your project, simply add the include path of maddy to yours
and in the code, you can then do the following:
@ -43,6 +43,24 @@ std::shared_ptr<maddy::Parser> parser = std::make_shared<maddy::Parser>();
std::string htmlOutput = parser->Parse(markdownInput);
```
## How to run the tests
*(tested on Linux with
[git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and
[cmake](https://cmake.org/install/) installed)*
Open your preferred terminal and type:
```shell
git clone https://github.com/progsource/maddy.git
cd maddy
git submodule update --init --recursive
mkdir tmp
cd tmp
cmake ..
make test # or run the executable in ../build/MaddyTests
```
## How to contribute
There are different possibilities: