diff --git a/.github/ISSUE_TEMPLATE/api_changed.md b/.github/ISSUE_TEMPLATE/api_changed.md new file mode 100644 index 0000000..cd64a05 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/api_changed.md @@ -0,0 +1,21 @@ +--- +name: External API changes +about: Use this template if the code requires modification due to api changes of any referenced library. Including other BHoM dlls +labels: "type:external-api-changes" + +--- + + + +#### Parent issue(s) or Pull Request(s) causing the changes: + + + +# + +#### Description: + + + +#### Test file(s): + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..edac8ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug +about: Use this template if an implementation provides incorrect results or causes crashes. +labels: "type:bug" + +--- + + + +#### Description: + + + +#### How to replicate: + + + +#### Expected behaviour: + + + +#### Test file(s): + diff --git a/.github/ISSUE_TEMPLATE/compliance.md b/.github/ISSUE_TEMPLATE/compliance.md new file mode 100644 index 0000000..b952d30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/compliance.md @@ -0,0 +1,15 @@ +--- +name: Compliance +about: Use this template to report code that doesn't follow the guidelines. +labels: "type:compliance" + +--- + + + +#### Broken rules: + + + +#### Suggestions to restore compliance: + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..03e44f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,15 @@ +--- +name: Documentation +about: Use this template to report missing or incorrect documentation in the code or in the wiki. +labels: "type:documentation" + +--- + + + +#### Describe the documentation issue: +- [ ] The code - the attribute of a method or class +- [ ] The wiki + +#### What is missing/incorrect? + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..ed41b48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature Request +about: Use this template to request a functionality that doesn't exist yet or is only partially implemented. +labels: "type:feature" + +--- + + + +#### Description: + + + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..99f64cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,11 @@ +--- +name: Question +about: https://bhom.slack.com/ can the right place for general questions. Use this template only if you have a specific question about the code or a procedure. +labels: "type:question" + +--- + + + + diff --git a/.github/ISSUE_TEMPLATE/test_script.md b/.github/ISSUE_TEMPLATE/test_script.md new file mode 100644 index 0000000..41fd83c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/test_script.md @@ -0,0 +1,11 @@ +--- +name: Test script +about: Use this template to create an automatic, regular check on a part of the code. +labels: "type:test-script" + +--- + + + +#### Area of the code or method(s) to be covered: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..3f70af9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ + + + +### NOTE: Depends on + + + + +### Issues addressed by this PR + + +Closes # + + + + +### Test files + + + +### Changelog + + + + +### Additional comments + \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5722632 --- /dev/null +++ b/.gitignore @@ -0,0 +1,67 @@ +# Compiled source # +################### +*.com +*.class +*.exe +*.o +*.so + +# Packages # +############ +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# Logs and databases # +###################### +*.log +*.sql +*.sqlite + +# OS generated files # +###################### +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + + +# build folders # +############### +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Bb]uild/ +[Pp]ackages/ + +# Visual Studio User File # +########################### +*.suo +*.user +.vs/ +Alligator/Alligator.csproj.orig +Alligator/Alligator_BACKUP_9848.csproj +Alligator/Alligator_BASE_9848.csproj +Alligator/Alligator_LOCAL_9848.csproj +Alligator/Alligator_REMOTE_9848.csproj + +# Exceptions # +############## +!/lib/*.dll diff --git a/Python_Engine/obj/Debug/Python_Engine.csproj.CoreCompileInputs.cache b/Python_Engine/obj/Debug/Python_Engine.csproj.CoreCompileInputs.cache index f5573ec..d5ee442 100644 --- a/Python_Engine/obj/Debug/Python_Engine.csproj.CoreCompileInputs.cache +++ b/Python_Engine/obj/Debug/Python_Engine.csproj.CoreCompileInputs.cache @@ -1 +1 @@ -7ea0431c507d4bcb7cc8078741837f11391fe8e1 +8f7c90e74474516938c3b2edfb8094fc713d6a06 diff --git a/Python_Toolkit.cs.sln b/Python_Toolkit.sln similarity index 100% rename from Python_Toolkit.cs.sln rename to Python_Toolkit.sln diff --git a/README.md b/README.md new file mode 100644 index 0000000..e93b16f --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) +# BHoM + +A great place to start is reading our Wiki [here](https://github.com/BHoM/documentation/wiki) including pages like the [Structure of the BHoM](https://github.com/BHoM/documentation/wiki/Structure-of-the-BHoM) and [Using the BHoM](https://github.com/BHoM/documentation/wiki/Using-the-BHoM). + +## Quick start ## + +Try the [installer](http://bhom.xyz/assets/installers/v2.1/BHoM%20Alpha%20v2.1.0.5%20Installer.exe) and a selection of [sample scripts](https://github.com/BHoM/samples). + + + +## Building the BHoM and the Toolkits from Source ## +You will need the following to build BHoM: + +- Microsoft Visual Studio 2013 or higher +- Microsoft .NET Framework 4.0 and above (included with Visual Studio 2013) +- Note that there are no software - specific dependencies (only operating system relevant), this is specific: BHoM is a software agnostic object model. + + +### Clone and build the Core BHoM Repos + +In the following build order: +- [BHoM](https://github.com/BHoM/BHoM) +- [BHoM_Engine](https://github.com/BHoM/BHoM_Engine) +- [BHoM_Adapter](https://github.com/BHoM/BHoM_Adapter) +- [BHoM_UI](https://github.com/BHoM/BHoM_UI) + +- [Socket_Toolkit](https://github.com/BHoM/Socket_Toolkit) +- [Mongo_Toolkit](https://github.com/BHoM/Mongo_Toolkit) + + +Build as many as you like of your chosen Interop Toolkits: +- [Revit_Toolkit](https://github.com/BHoM/Revit_Toolkit) +- [Robot_Toolkit](https://github.com/BHoM/Robot_Toolkit) +- [ETABS_Toolkit](https://github.com/BHoM/ETABS_Toolkit) +- [Lusas_Toolkit](https://github.com/BHoM/Lusas_Toolkit) +- [GSA_Toolkit](https://github.com/BHoM/GSA_Toolkit) +- [TAS_Toolkit](https://github.com/BHoM/TAS_Toolkit) +- [XML_Toolkit](https://github.com/BHoM/XML_Toolkit) + +Then build as many User Interface Repositories as you like: +- [Rhinoceros_Toolkit](https://github.com/BHoM/Rhinoceros_Toolkit) & [Grasshopper_Toolkit](https://github.com/BHoM/Grasshopper_Toolkit) (you need both) +- [Dynamo_Toolkit](https://github.com/BHoM/Dynamo_Toolkit) +- [Excel_Toolkit](https://github.com/BHoM/Excel_Toolkit) + + +You are good to go! + + + +## Want to contribute? ## + +BHoM is an open-source project and would be nothing without its community. Take a look at our contributing guidelines and tips [here](https://github.com/BHoM/BHoM/blob/master/CONTRIBUTING.md). + + +## Licence ## + +BHoM is free software licenced under GNU Lesser General Public Licence - [https://www.gnu.org/licenses/lgpl-3.0.html](https://www.gnu.org/licenses/lgpl-3.0.html) +Each contributor holds copyright over their respective contributions. +The project versioning (Git) records all such contribution source information. +See [LICENSE](https://github.com/BHoM/BHoM/blob/master/LICENSE) and [COPYRIGHT_HEADER](https://github.com/BHoM/BHoM/blob/master/COPYRIGHT_HEADER.txt). \ No newline at end of file