Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
epignatelli committed Dec 6, 2019
1 parent 1cc63e3 commit 0bfebed
Show file tree
Hide file tree
Showing 12 changed files with 266 additions and 1 deletion.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/api_changed.md
Original file line number Diff line number Diff line change
@@ -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"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Parent issue(s) or Pull Request(s) causing the changes:
<!-- If appropriate please reference the url of any other issue(s) that forces the current change-->
<!-- Note: that this is usually a change in an external API -->

#

#### Description:
<!-- Add a brief description -->


#### Test file(s):
<!-- Link to test files to validate the proposed changes -->
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug
about: Use this template if an implementation provides incorrect results or causes crashes.
labels: "type:bug"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Description:
<!-- Add a brief description -->


#### How to replicate:
<!-- Describe a routine that allows developers to replicate the issue -->


#### Expected behaviour:
<!-- What result would you expect from the fix? -->


#### Test file(s):
<!-- Link to test files to validate the proposed changes -->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/compliance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Compliance
about: Use this template to report code that doesn't follow the guidelines.
labels: "type:compliance"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Broken rules:
<!-- Add a brief description of what is incorrect or missing -->


#### Suggestions to restore compliance:
<!-- Any guidance or suggestion on how to bring the element back to compliance -->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -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"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Describe the documentation issue:
- [ ] The code - the attribute of a method or class
- [ ] The wiki

#### What is missing/incorrect?
<!-- Details of desired documentation? -->
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Description:
<!-- Add a brief description of what functionality is missing, including sufficient details of expected behaviour -->



11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

<!-- If you need to ask on slack, you can use this link
https://join.slack.com/t/bhom/shared_invite/enQtNTQzNjkyNzIzMjM1LTU4NDE1OTJhZDk4NjFmNDkwYWQ0NDIwNTNhMjZmMGQwMjhiMTZlMDdiMTgwMzEzMDhlODdjMDVkZmE5MjI1OTQ -->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/test_script.md
Original file line number Diff line number Diff line change
@@ -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"

---
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH ISSUE CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

#### Area of the code or method(s) to be covered:
<!-- Describe the breadth of the proposed coverage -->
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- PLEASE ENSURE YOU REVIEW THE CONTENT OF EACH PR CAREFULLY, INCLUDING SUBSEQUENT COMMENTS BY YOURSELF OR OTHERS. -->
<!-- IN PARTICULAR PLEASE ENSURE THAT SENSITIVE OR INAPPROPRIATE INFORMATION IS NOT UPLOADED -->

### NOTE: Depends on
<!-- Link to any additional PRs in other repos required for this PR to function -->
<!-- Delete if not required -->


### Issues addressed by this PR
<!-- Add reference(s) to issue(s) solved by this PR. Please use keyword Fixes/Closes as per https://help.github.com/articles/closing-issues-using-keywords/ -->

Closes #

<!-- Add short description of what has been fixed -->


### Test files
<!-- Link to test files to validate the proposed changes -->


### Changelog
<!-- Text to go into changelog if applicable -->
<!-- Please see https://github.com/BHoM/documentation/wiki/changelog for guidelines -->


### Additional comments
<!-- As required -->
67 changes: 67 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7ea0431c507d4bcb7cc8078741837f11391fe8e1
8f7c90e74474516938c3b2edfb8094fc713d6a06
File renamed without changes.
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 0bfebed

Please sign in to comment.