qsmaddy/README.md

72 line
1.8 KiB
Markdown

2017-12-25 12:22:35 +01:00
# maddy
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
2018-01-18 19:09:39 +01:00
[![Version: 1.0.3](https://img.shields.io/badge/Version-1.0.3-brightgreen.svg)](https://semver.org/)
2017-12-26 15:09:37 +01:00
[![Build Status](https://travis-ci.org/progsource/maddy.svg?branch=master)](https://travis-ci.org/progsource/maddy)
2017-12-25 12:22:35 +01:00
maddy is a C++ Markdown to HTML **header-only** parser library.
2017-12-25 14:50:26 +01:00
## Supported OS
2017-12-25 12:22:35 +01:00
It actually should work on any OS, that supports the C++14 standard library.
It is tested to work on:
* Linux (without exceptions and without RTTI)
## Dependencies
* C++14
## Why maddy?
When I was needing a Markdown parser in C++ I couldn't find any, that was
fitting my needs. So I simply wrote my own one.
## Markdown syntax
The supported syntax can be found in the [definitions docs](docs/definitions.md).
2017-12-30 03:37:18 +01:00
## How to use
2017-12-25 12:22:35 +01:00
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:
```c++
#include <memory>
#include <string>
#include "maddy/parser.h"
std::stringstream markdownInput("");
std::shared_ptr<maddy::Parser> parser = std::make_shared<maddy::Parser>();
std::string htmlOutput = parser->Parse(markdownInput);
```
2017-12-30 03:37:18 +01:00
## 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
2017-12-30 03:37:18 +01:00
make test # or run the executable in ../build/MaddyTests
```
2017-12-25 12:22:35 +01:00
## How to contribute
There are different possibilities:
2018-10-25 17:26:25 +02:00
* [Create a GitHub issue](https://github.com/progsource/maddy/issues/new)
2017-12-25 12:22:35 +01:00
* Create a pull request with an own branch (don't forget to put yourself in the
AUTHORS file)