Skip to content

Commit 2aa36e1

Browse files
authored
Create README.md
1 parent 169bd68 commit 2aa36e1

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

README.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<h1 align="center">Geode<sup><i>by Geode-solutions</i></sup></h1>
2+
<h3 align="center">Geode-solutions open-source software for visualization, modeling and much more</h3>
3+
4+
<p align="center">
5+
<img src="https://github.com/Geode-solutions/GeodePackage/workflows/CI/badge.svg" alt="Build Status">
6+
<img src="https://github.com/Geode-solutions/GeodePackage/workflows/CD/badge.svg" alt="Deploy Status">
7+
<img src="https://img.shields.io/github/release/Geode-solutions/GeodePackage.svg" alt="Version">
8+
</p>
9+
10+
<p align="center">
11+
<img src="https://img.shields.io/static/v1?label=Windows&logo=windows&logoColor=white&message=support&color=success" alt="Windows support">
12+
<img src="https://img.shields.io/static/v1?label=Ubuntu&logo=Ubuntu&logoColor=white&message=support&color=success" alt="Ubuntu support">
13+
</p>
14+
15+
<p align="center">
16+
<img src="https://img.shields.io/badge/license-LGPL 3.0-blue.svg" alt="License">
17+
<img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="Semantic-release">
18+
<a href="https://slackin-opengeode.herokuapp.com">
19+
<img src="https://slackin-opengeode.herokuapp.com/badge.svg" alt="Slack invite">
20+
</a>
21+
</p>
22+
23+
---
24+
25+
## Introduction
26+
27+
Geode is an open source viewer for manipulating geometric models, from simple meshes to complex boundary representations.
28+
29+
![Geode](https://github.com/Geode-solutions/GeodePackage/blob/master/UI.png)
30+
31+
32+
## Ecosystem
33+
34+
| Project | Version | Description |
35+
|---------|---------|-------------|
36+
| [OpenGeode] | ![OpenGeode-version] | Open source framework for representing and manipulating geometric models |
37+
| [OpenGeode-IO] | ![OpenGeode-IO-version] | Implementation of input and output formats |
38+
| [OpenGeode-Geosciences] | ![OpenGeode-Geosciences-version] | Custom objects and algorithms tailored for Geosciences |
39+
| [OpenGeode-GeosciencesIO] | ![OpenGeode-GeosciencesIO-version] | Implementation of input and output formats for Geosciences |
40+
41+
[OpenGeode]: https://github.com/Geode-solutions/OpenGeode
42+
[OpenGeode-version]: https://img.shields.io/github/release/Geode-solutions/OpenGeode.svg
43+
44+
[OpenGeode-IO]: https://github.com/Geode-solutions/OpenGeode-IO
45+
[OpenGeode-IO-version]: https://img.shields.io/github/release/Geode-solutions/OpenGeode-IO.svg
46+
47+
[OpenGeode-Geosciences]: https://github.com/Geode-solutions/OpenGeode-Geosciences
48+
[OpenGeode-Geosciences-version]: https://img.shields.io/github/release/Geode-solutions/OpenGeode-Geosciences.svg
49+
50+
[OpenGeode-GeosciencesIO]: https://github.com/Geode-solutions/OpenGeode-GeosciencesIO
51+
[OpenGeode-GeosciencesIO-version]: https://img.shields.io/github/release/Geode-solutions/OpenGeode-GeosciencesIO.svg
52+
53+
54+
## Documentation
55+
56+
To get Geode, go to the [release page](https://github.com/Geode-solutions/GeodePackage/releases/). Download the version corresponding to:
57+
* your version of Python;
58+
* your platform: win64 for Windows, or ubuntu for Debian-based.
59+
60+
Run the ```geode``` executable!
61+
62+
63+
## Questions
64+
For questions and support please use the official [slack](https://slackin-opengeode.herokuapp.com) and channel #help.
65+
The issue list of this repo is exclusively for bug reports and feature requests.
66+
67+
68+
## License
69+
70+
[LGPL-3.0](https://opensource.org/licenses/LGPL-3.0)
71+
72+
Copyright (c) 2019 - 2020, Geode-solutions

0 commit comments

Comments
 (0)