Skip to content

Commit

Permalink
Merge pull request #395 from GSharker/dev/ceca/update-docs-home
Browse files Browse the repository at this point in the history
Updated the index.md
  • Loading branch information
cesarecaoduro authored Jan 4, 2023
2 parents 415781c + c2718fd commit 94f4f73
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Introduction to G-Shark
G-Shark is the nickname for Geometry Shark. It all started with the need of finding a geometry kernel able to handle curves, surfaces, mesh and solid in a C# (hence the first name was actually G-Shark). There are plenty of libraries written in C++, Python and some of them also in C# but we couldn't find a library to rule them all and, most important, free and open source. For this reason we have started this crazy project going back to books, learning from other libraries (which we thank for) and finally provinding our own touch to it.
![](https://img.shields.io/badge/Framwork-.NetStandard2.0-blue?logo=.NET)
![Nuget](https://img.shields.io/nuget/v/GShark?logo=NuGet&color=004880)
[![Build and Test](https://github.com/GSharker/G-Shark/actions/workflows/build-and-test-on-pr.yml/badge.svg?branch=develop&event=pull_request)](https://github.com/GSharker/G-Shark/actions/workflows/build-and-test-on-pr.yml)
[![Build docs](https://github.com/GSharker/G-Shark/actions/workflows/build-docs.yml/badge.svg?branch=master)](https://github.com/GSharker/G-Shark/actions/workflows/build-docs.yml)

We are very far from beeing super performant and, in fact, we are still writing code and committing every day something new. The idea is to have something that is software agnostic, hopefully well documented and easy to use.
[![](https://dcbadge.vercel.app/api/server/RPz2XZEtbc?style=flat)](https://discord.gg/RPz2XZEtbc)
![](./media/gshark-banner.jpg "Geometry Shark")

Cesare Caoduro [![Twitter][TwitterLogo]][CesareTwitter]<br/>
Mirco Bianchini [![Twitter][TwitterLogo]][MircoTwitter]
# The project
**G-Shark** is short for **Geometry Shark**. It all started with a need for a geometry library able to handle curves, surfaces, meshes and solids written in C#. Although there
are plenty of geometry libraries written in a variety of languages including C, C++, Python and some also in C# but, as is often the case, we could not find a library that encompassed all the functionality that we were looking for in one place.

[MircoTwitter]: https://twitter.com/sonomirco
[CesareTwitter]: https://twitter.com/CesareCaoduro
For this reason we began work on this ambitious project to create an easy to use, well documented, and highly functional geometry library for C# development, targeted primarily at the AECO sector and computational designers. We've gone back to the text books and first principles of computational geometry, and we learn what we can from the great work done by others before us for which we are very thankful, in particular [Verb](http://verbnurbs.com/), [NurbsPython](https://github.com/orbingol/NURBS-Python) and [OpenNurbs](https://github.com/mcneel/opennurbs) which are our references for the backbone of this library.

[TwitterLogo]: ./images/TwitterLogo.png
We try to write and commit code every day and look forward to contributions from the open source dev community.

There's a tonne of work to be done and we appreciate all the help we can get! If you would like to contribute, reach out and we'll have you committing code in no time! :)

[Cesare Caoduro](https://www.linkedin.com/in/cesarecaoduro/)<br/>
[Mirco Bianchini](https://www.linkedin.com/in/mirco-bianchini-352b2128/)<br/>
[Guido Maciocchi](https://www.linkedin.com/in/guido-maciocci-709a9412)

0 comments on commit 94f4f73

Please sign in to comment.