From 167ce3943d6e27ddc862e6ce52cf5a79c5a794de Mon Sep 17 00:00:00 2001 From: Albert S Date: Sun, 18 Apr 2021 12:31:08 +0200 Subject: [PATCH] Update README --- README.md | 83 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index e5d457f..de01561 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,3 @@ -# maddy +# qsmaddy -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![Version: 1.1.2](https://img.shields.io/badge/Version-1.1.2-brightgreen.svg)](https://semver.org/) -[![Travis Build Status](https://travis-ci.org/progsource/maddy.svg?branch=master)](https://travis-ci.org/progsource/maddy) -[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/04m0lg27kigv1pg8/branch/master?svg=true)](https://ci.appveyor.com/project/progsource/maddy/branch/master) - -maddy is a C++ Markdown to HTML **header-only** parser library. - -## Supported OS - -It actually should work on any OS, that supports the C++14 standard library. - -It is tested to work on: - -* Linux (gcc) -* OSX (clang) -* Windows (Visual Studio 2017) - -## 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). - -## 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: - -```c++ -#include -#include - -#include "maddy/parser.h" - -std::stringstream markdownInput(""); - -// config is optional -std::shared_ptr config = std::make_shared(); -config->isEmphasizedParserEnabled = true; // default -config->isHTMLWrappedInParagraph = true; // default - -std::shared_ptr parser = std::make_shared(config); -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 -make test # or run the executable in ../build/MaddyTests -``` - -## How to contribute - -There are different possibilities: - -* [Create a GitHub issue](https://github.com/progsource/maddy/issues/new) -* Create a pull request with an own branch (don't forget to put yourself in the - AUTHORS file) - -Please also read [CONTRIBUTING.md](CONTRIBUTING.md). +Fork of [maddy](https://github.com/progsource/maddy) with some quick hacks to make it fit better for [qswiki](https://gitea.quitesimple.org/crtxcr/qswiki)