crtxcr/qsmaddy
1
0
Fork 0
réplica de https://github.com/quitesimpleorg/qsmaddy.git synced 2025-04-18 18:29:02 +02:00
Código Incidencias Proyectos Lanzamientos Wiki Actividad

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

Explorar el Código 
added howto for running the tests
Este commit está contenido en:
Petra Baranski 2017-12-30 03:42:03 +01:00 cometido por GitHub
commit d300d3a92a
No se encontró ninguna clave conocida en la base de datos para esta firma
ID de clave GPG: 4AEE18F83AFDEB23
Se han modificado 1 ficheros con 19 adiciones y 1 borrados
Mostrar estadísticas Descargar archivo de parche Descargar archivo de diferencias Expandir todos los archivos Contraer todos los archivos

20
README.md
Ver fichero

@ -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). 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 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: 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); 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 ## How to contribute
There are different possibilities: There are different possibilities: