diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..7d1776f --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,24 @@ + +## How to build RhinoLink + +RhinoLink has several buildable components, including documentation. This document covers building everything but the documentation. + +#### Prerequisites +* Version 11.0 or greater of Mathematica or Wolfram Desktop +* Version 6 or greater of Rhinoceros +* Visual Studio (eg, Community Edition) + +#### Building RhinoLink +* Start Visual Studio and open the project file `RhinoLink\VisualStudioBuild\RhinoLink.sln`. +* Choose Build > Rebuild Solution. + +#### Installing RhinoLink +* In Mathematica, run `PacletInstall["your\path\RhinoLink\RhinoLink"]`. +* Load the RhinoLink package with `Get["RhinoLink"]`. +* Install RhinoLink components by evaluating `InstallRhinoPlugin[]`. + +#### Running RhinoLink +* Start Rhino and run the command `WolframConnect`. +* Start Mathematica, create a new notebook, and set the notebook's kernel to RhinoAttach by choosing Evaluation > Notebook's Kernel > RhinoAttach. +* Test if RhinoLink is running by evaluating `RhinoDocObjects[]`. It should return an empty list (or a non-empty list if you have a non-empty Rhino document). +* In the Help Browser (Help > Wolfram Documentation), search for RhinoLink to bring up the guide page, which contains links to the complete documentation. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..391f446 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to Wolfram® + +Thank you for taking the time to contribute to the [Wolfram Research](https://github.com/wolframresearch) repos on GitHub. + +## Licensing of Contributions + +By contributing to Wolfram, you agree and affirm that: + +> Wolfram may release your contribution under the terms of the [MIT license](https://opensource.org/licenses/MIT); and + +> You have read and agreed to the [Developer Certificate of Origin](http://developercertificate.org/), version 1.1 or later. + +Please see [COPYING.md](COPYING.md) for licensing conditions pertaining +to individual repositories. + + +## Bug reports + +### Security Bugs + +Please **DO NOT** file a public issue regarding a security issue. +Rather, send your report privately to security@wolfram.com. Security +reports are appreciated and we will credit you for it. We do not offer +a security bounty, but the forecast in your neighborhood will be cloudy +with a chance of Wolfram schwag! + +### General Bugs + +Please use the repository issues page to submit general bug issues. + +Please do not duplicate issues. + +Please do send a complete and well-written report to us. Note: **the +thoroughness of your report will positively correlate to our willingness +and ability to address it**. + +When reporting issues, always include: + +* Your version of *Mathematica*® or the Wolfram Language™. +* Your version of Rhino. +* Your operating system. diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..1cdb62f --- /dev/null +++ b/COPYING.md @@ -0,0 +1,9 @@ +RhinoLink is Copyright (C) 2018, Wolfram Research, Inc. + +--- + +[![Create Commons License](https://i.creativecommons.org/l/by-nc/4.0/88x31.png)](http://creativecommons.org/licenses/by-nc/4.0/) + + +This work is licensed under a [Creative Commons Attribution-NonCommercial 4.0 International License](http://creativecommons.org/licenses/by-nc/4.0/). + diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4ab297 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ + +# RhinoLink for Wolfram Language + +![RhinoLinkLogo](RhinoLinkLogo.png) + +RhinoLink is a prototype Wolfram Language paclet that provides a two-way communication link between McNeel and Associates' [Rhino](https://www.rhino3d.com/) and [Mathematica](http://www.wolfram.com/mathematica/) or [Wolfram Desktop](https://www.wolfram.com/desktop/). With RhinoLink you can: + +* script Rhino with Wolfram Language code +* create Grasshopper components that encapsulate Wolfram Language code +* control Rhino content with Wolfram Language interfaces +* source Rhino geometry from Mathematica +* include Wolfram Language code directly in Grasshopper structures +* use Rhino as a geometry server from Wolfram Language + +RhinoLink currently supports Rhino 6 for Windows and Mathematica versions 11.0+. + +### Installing the RhinoLink release + +The RhinoLink release comes in the form of a `.paclet` file, which contains the entire package and its documentation. Download the latest release from the [GitHub repo's releases page](https://github.com/WolframResearch/RhinoLink/releases). To permanently install the RhinoLink paclet, run the following commands in the Wolfram Language: + + PacletInstall["/full/path/to/RhinoLink.paclet"] + < Notebook's Kernel. + +To get an overview of RhinoLink functionality, search for RhinoLink in the help browser, which should bring up the RhinoLink guide page. The guide page contains links to documentation of all RhinoLink function as well as links to tutorials to help get you started. + +Start with the "Control a Parametric Surface in Rhino with a Manipulate Interface in Mathematica" or "Create Box Structures in Rhino with an Interface in Mathematica" tutorials to see how to use RhinoLink with Rhino. For a basic example of creating a Grasshopper component, start with "Make a Grasshopper Component that Translates Graphics3D Output to Rhino Meshes". The basics of .NET programming with Wolfram Language are explained in the "Use NETLink to Examine and Create Objects in Rhino" tutorial. + +### Who is behind this? + +RhinoLink is maintained by [Christopher Carlson](https://github.com/carlsongithub) and Todd Gayley of [Wolfram Research](http://wolfram.com/). Todd created RhinoLink on top of his [.NET/Link](http://reference.wolfram.com/language/NETLink/tutorial/Overview.html) package, and Chris created the examples, RhinoLink utilities, and documentation. + +### How can you help? + +The 0.9 release of RhinoLink has a basic set of utilities that convert between Rhino and Wolfram Language data types. The richer that set, the more useful RhinoLink will become. We welcome contributions from outside developers. + +### Further information + +See the following files for more information: + +* [COPYING.md](COPYING.md) - RhinoLink license +* [CONTRIBUTING.md](CONTRIBUTING.md) - Guidelines for contributing to RhinoLink +* [BUILDING.md](BUILDING.md) - Instructions for building and debugging RhinoLink