From 04cd0e746e0f3d4458286cc37b6c19ed1c0e89b3 Mon Sep 17 00:00:00 2001 From: Alan Rynne Date: Sat, 20 Jun 2020 22:31:37 +0200 Subject: [PATCH] Updated docs, changelog and readme --- CHANGELOG.md | 4 ++- README.md | 37 ++++++++++++++++----------- docfx_project/index.md | 58 +++++++++++++++++++++++++++++++++++++++--- 3 files changed, 79 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04069eb..dee92d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased -To be filled in... +## [0.0.6] - 14-June-2020 + +Yup! Versioning is hard... I didn't do a good job of keeping track of the changes, so version `0.0.2 -> 0.0.6` will go under the *"major improvements"* category. I promise to do better next time! 🤞🏻 ## [0.0.1] - 10-Feb-2020 diff --git a/README.md b/README.md index c1f4500..30c1f5c 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,35 @@ # Architectrual Geometry Library for .Net +![Project Status](https://img.shields.io/badge/status-Under%20Development-red.svg) [![Target Framework](https://img.shields.io/badge/Target%20Framework-.NetStandard2.0-blueviolet.svg)](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) -![Project Status](https://img.shields.io/badge/Status-Under%20Development-red.svg) [![License](https://img.shields.io/github/license/Paramdigma/Core.svg)](https://github.com/Paramdigma/Core/blob/master/LICENSE) + +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/paramdigma/core?sort=semver) +![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/paramdigma/core/latest/master?sort=semver) ![Main language](https://img.shields.io/github/languages/top/Paramdigma/Core.svg) ![Code Size](https://img.shields.io/github/languages/code-size/Paramdigma/Core.svg) -| Service | Master | Develop | -| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| CI Status | [![Build Status](https://travis-ci.com/Paramdigma/Core.svg?branch=master)](https://travis-ci.com/Paramdigma/Core) | [![Build Status](https://travis-ci.com/Paramdigma/Core.svg?branch=develop)](https://travis-ci.com/Paramdigma/Core) | -| Code Quality | [![CodeFactor](https://www.codefactor.io/repository/github/Paramdigma/Core/badge/master)](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/master) | [![CodeFactor](https://www.codefactor.io/repository/github/Paramdigma/Core/badge/develop)](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/develop) | -| Test Coverage | [![codecov](https://codecov.io/gh/Paramdigma/Core/branch/master/graph/badge.svg)](https://codecov.io/gh/Paramdigma/Core/branch/master) | [![codecov](https://codecov.io/gh/Paramdigma/Core/branch/develop/graph/badge.svg)](https://codecov.io/gh/Paramdigma/Core/branch/develop) | +**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. -## Objective +Currently, we are starting development of: -**Paramdigma.Core** is _(or will be)_ an independent and open source library for **_Architectural Geometry_** algorithms developed by myself. +- [McNeel Rhinoceros/Grasshopper](https://github.com/paramdigma/core.grasshopper) +- [Autodesk Revit/Dynamo](https://github.com/paramdigma/core.dynamo) -The core idea is to create a complete package of 3D entities and functions that could be easily connected to different software solutions like: +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) -- McNeel Rhinoceros/Grasshopper -- Autodesk Revit/Dynamo -- Autocad +> 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! 🚀 -But also available as a: -- CLI -- NuGet Package +## Status + +| | `master` | `develop` | +| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| _CI Status_ | [![Build Status](https://travis-ci.com/Paramdigma/Core.svg?branch=master)](https://travis-ci.com/Paramdigma/Core) | [![Build Status](https://travis-ci.com/Paramdigma/Core.svg?branch=develop)](https://travis-ci.com/Paramdigma/Core) | +| _Code Quality_ | [![CodeFactor](https://www.codefactor.io/repository/github/Paramdigma/Core/badge/master)](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/master) | [![CodeFactor](https://www.codefactor.io/repository/github/Paramdigma/Core/badge/develop)](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/develop) | +| _Test Coverage_ | [![codecov](https://codecov.io/gh/Paramdigma/Core/branch/master/graph/badge.svg)](https://codecov.io/gh/Paramdigma/Core/branch/master) | [![codecov](https://codecov.io/gh/Paramdigma/Core/branch/develop/graph/badge.svg)](https://codecov.io/gh/Paramdigma/Core/branch/develop) | ## Usage @@ -45,3 +50,5 @@ You can find the Docfx built documentation for the latest relase on the 'master' 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. \ No newline at end of file diff --git a/docfx_project/index.md b/docfx_project/index.md index 95887de..ce0881d 100644 --- a/docfx_project/index.md +++ b/docfx_project/index.md @@ -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 + +![Project Status](https://img.shields.io/badge/status-Under%20Development-red.svg) +![Target Framework](https://img.shields.io/badge/target-.NetStandard2.1-blueviolet.svg) +[![License](https://img.shields.io/github/license/Paramdigma/Core.svg)](https://github.com/Paramdigma/Core/blob/development/LICENSE) + +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/paramdigma/core?sort=semver) +![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/paramdigma/core/latest/master?sort=semver) +![Main language](https://img.shields.io/github/languages/top/Paramdigma/Core.svg) +![Code Size](https://img.shields.io/github/languages/code-size/Paramdigma/Core.svg) + +**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_ | [![Build Status](https://travis-ci.com/Paramdigma/Core.svg?branch=master)](https://travis-ci.com/Paramdigma/Core) | [![Build Status](https://travis-ci.com/Paramdigma/Core.svg?branch=develop)](https://travis-ci.com/Paramdigma/Core) | +| _Code Quality_ | [![CodeFactor](https://www.codefactor.io/repository/github/Paramdigma/Core/badge/master)](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/master) | [![CodeFactor](https://www.codefactor.io/repository/github/Paramdigma/Core/badge/develop)](https://www.codefactor.io/repository/github/Paramdigma/Core/overview/develop) | +| _Test Coverage_ | [![codecov](https://codecov.io/gh/Paramdigma/Core/branch/master/graph/badge.svg)](https://codecov.io/gh/Paramdigma/Core/branch/master) | [![codecov](https://codecov.io/gh/Paramdigma/Core/branch/develop/graph/badge.svg)](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. \ No newline at end of file