forked from AlanRynne/AR_Lib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
79 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,54 @@ | ||
| # This is the **HOMEPAGE**. | ||
| Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. | ||
| ## Quick Start Notes: | ||
| 1. Add images to the *images* folder if the file is referencing an image. | ||
| # Architectrual Geometry Library for .Net | ||
|
|
||
|  | ||
|  | ||
| [](https://github.com/Paramdigma/Core/blob/development/LICENSE) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| **Paramdigma.Core** is _(or will be)_ an independent and open source library for **_Architectural Geometry_** algorithms developed by @AlanRynne. | ||
|
|
||
| The core idea is to create a complete package of 3D entities and functions that could be easily connected to different software solutions, via secondary projects that will act as wrappers for the library. | ||
|
|
||
| Currently, we are starting development of: | ||
|
|
||
| - [McNeel Rhinoceros/Grasshopper](https://github.com/paramdigma/core.grasshopper) | ||
| - [Autodesk Revit/Dynamo](https://github.com/paramdigma/core.dynamo) | ||
|
|
||
| If you are looking for just a geometry library to plug into a project we also provide a NuGet package. | ||
| - [Paramdigma.Core NuGet Package (GPR hosted)](https://github.com/Paramdigma/Core/packages/268763) | ||
|
|
||
| > Github Package Registry is kind of new... If you don't know how to setup GPR for your projects, follow the first step in [THIS GUIDE](https://help.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-dotnet-cli-for-use-with-github-packages#authenticating-with-a-personal-access-token). Once that is done, you are good to go! 🚀 | ||
| ## Status | ||
|
|
||
| | | `master` | `develop` | | ||
| | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | _CI Status_ | [](https://travis-ci.com/Paramdigma/Core) | [](https://travis-ci.com/Paramdigma/Core) | | ||
| | _Code Quality_ | [](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/master) | [](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/develop) | | ||
| | _Test Coverage_ | [](https://codecov.io/gh/Paramdigma/Core/branch/master) | [](https://codecov.io/gh/Paramdigma/Core/branch/develop) | | ||
|
|
||
| ## Usage | ||
|
|
||
| > This section will be written very shortly! | ||
| ## Documentation | ||
|
|
||
| You can find the Docfx built documentation for the latest relase on the 'master' branch at: | ||
|
|
||
| [https://paramdigma.com/Core/](https://paramdigma.com/Core/) | ||
|
|
||
| > I'm planning on supporting multiple versions on the docs in the future, for now, only the latest release will be documented. | ||
| > | ||
| > For previous releases, you can always build the docs locally with DocFx. | ||
| ## Contributing | ||
|
|
||
| I haven't developed any contributing guidelines, although the `master` branch is _push protected_ and is connected to Travis-CI so all contributions should pass build tests. | ||
|
|
||
| If you want to contribute to this library, feel free to fork this repo and create a pull request with any modifications. | ||
|
|
||
| The makes heavy use of GitHub Actions automation capabilities to test and deploy the library. Reach out to @AlanRynne for any doubts on this. |