Skip to content

Commit 50a5730

Browse files
Pierre Anquezpanquez
authored andcommitted
fix(ReadMe): update readme
BREAKING CHANGE: generate a release
1 parent 0dbcdc0 commit 50a5730

File tree

2 files changed

+55
-3
lines changed

2 files changed

+55
-3
lines changed

README.md

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,46 @@
1-
# OpenGeode-ModuleTemplate
1+
<h1 align="center">OpenGeode-ModuleTemplate<sup><i>by Geode-solutions</i></sup></h1>
2+
<h3 align="center">Template for creating your own OpenGeode modules</h3>
23

3-
Template for OpenGeode modules.
4+
<p align="center">
5+
<img src="https://dev.azure.com/GeodeSolutions/Geode/_apis/build/status/Geode-solutions.OpenGeode-ModuleTemplate?branchName=master" alt="Build Status">
6+
<img src="https://img.shields.io/azure-devops/tests/GeodeSolutions/Geode/10/master.svg?compact_message" alt="Test Status">
7+
<img src="https://img.shields.io/azure-devops/coverage/GeodeSolutions/Geode/10/master.svg" alt="Coverage Status">
8+
<img src="https://img.shields.io/github/release/Geode-solutions/OpenGeode-ModuleTemplate.svg" alt="Version">
9+
</p>
410

5-
Please have a look at this page : https://help.github.com/en/articles/creating-a-repository-from-a-template
11+
<p align="center">
12+
<img src="https://dev.azure.com/GeodeSolutions/Geode/_apis/build/status/Geode-solutions.OpenGeode-ModuleTemplate?branchName=master&jobName=Test_Windows&label=Windows" alt="Windows Build Status">
13+
<img src="https://dev.azure.com/GeodeSolutions/Geode/_apis/build/status/Geode-solutions.OpenGeode-ModuleTemplate?branchName=master&jobName=Test_Ubuntu&label=Linux" alt="Linux Build Status">
14+
<img src="https://dev.azure.com/GeodeSolutions/Geode/_apis/build/status/Geode-solutions.OpenGeode-ModuleTemplate?branchName=master&jobName=Test_Mac&label=macOS" alt="Apple Build Status">
15+
</p>
16+
17+
<p align="center">
18+
<img src="https://img.shields.io/badge/C%2B%2B-11-blue.svg" alt="Language">
19+
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
20+
<img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="Semantic-release">
21+
<a href="https://slackin-opengeode.herokuapp.com"><img src="https://slackin-opengeode.herokuapp.com/badge.svg" alt="Slack invite"></a>
22+
</p>
23+
24+
---
25+
26+
## Introduction
27+
28+
OpenGeode-ModuleTemplate provides a template for creating an [OpenGeode] module.
29+
30+
[OpenGeode]: https://github.com/Geode-solutions/OpenGeode
31+
32+
## Documentation
33+
34+
To know how to use this template, please have a look at this page: https://help.github.com/en/articles/creating-a-repository-from-a-template
35+
36+
Have also a look at this [OpenGeode] documentation: https://docs.geode-solutions.com/opengeode then click on "How to create your own OpenGeode module"
37+
38+
## Questions
39+
For questions and support please use the official [slack](https://slackin-opengeode.herokuapp.com) and go to the channel #module_template. The issue list of this repo is exclusively for bug reports and feature requests.
40+
41+
42+
## License
43+
44+
[MIT](https://opensource.org/licenses/MIT)
45+
46+
Copyright (c) 2019-present, Geode-solutions

azure-pipelines.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ jobs:
2424
parameters:
2525
type: "Debug"
2626
cmakeArgs: "-DCMAKE_PREFIX_PATH=$(OPENGEODEPATH)"
27+
- template: unix-testing.yml@templates
28+
parameters:
29+
type: "Debug"
30+
cmakeArgs: "-DCMAKE_PREFIX_PATH=$(OPENGEODEPATH);$(Build.SourcesDirectory)/build"
31+
- template: coverage.yml@templates
32+
parameters:
33+
directory: "$(Build.SourcesDirectory)/build/bin"
2734

2835
- job: Test_Windows
2936
dependsOn: Format
@@ -56,6 +63,10 @@ jobs:
5663
parameters:
5764
type: "Debug"
5865
cmakeArgs: "-DCMAKE_PREFIX_PATH=$(OPENGEODEPATH)"
66+
- template: unix-testing.yml@templates
67+
parameters:
68+
type: "Debug"
69+
cmakeArgs: "-DCMAKE_PREFIX_PATH=$(OPENGEODEPATH);$(Build.SourcesDirectory)/build"
5970

6071
- template: semantic-release.yml@templates
6172
parameters:

0 commit comments

Comments
 (0)