From b439596d37f040475696c4fbcd7f09904936968c Mon Sep 17 00:00:00 2001 From: Will Pearson Date: Wed, 17 Oct 2018 00:20:02 +0100 Subject: [PATCH 1/3] Refine readme Make it short and sweet, containing _just enough_ info to get started whilst directing readers to devdocs as the single source of truth --- README.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8a7f86a8..36443f8f 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,9 @@ [![Discourse users](https://img.shields.io/discourse/https/discourse.mcneel.com/users.svg)](https://discourse.mcneel.com/c/opennurbs) -The openNURBS Initiative provides CAD, CAM, CAE, and computer graphics software developers the tools to accurately transfer 3-D geometry between applications. +The openNURBS Initiative provides CAD, CAM, CAE, and computer graphics software developers the tools to accurately transfer 3D geometry between applications. -The openNURBS Toolkit consists of C++ source code for a library that will read and write openNURBS 3D model files (_.3dm_). More than 400 software development teams and applications, including _Rhinoceros®_, exchange 3D models using the openNURBS (_.3dm_) file format. - -The openNURBS Toolkit reads and writes all Rhino 3DM files. Additionally, the openNURBS Toolkit provides NURBS evaluation tools and elementary geometric and 3D view manipulation tools. +The openNURBS Toolkit consists of C++ source code for a library that will read and write openNURBS 3D model files (_.3dm_). More than 400 software development teams and applications, including [_Rhinoceros®_](https://rhino3d.com), exchange 3D models using the openNURBS file format. Additionally, the Toolkit provides NURBS evaluation tools and elementary geometric and 3D view manipulation tools as well as including source code for several example programs. Unlike other open development initiatives, alliances, or consortia: @@ -15,8 +13,6 @@ Unlike other open development initiatives, alliances, or consortia: * There are no restrictions. Neither copyright nor copyleft restrictions apply. * No contribution of effort or technology is required from the members, although it is encouraged. -The openNURBS Toolkit is intended for C++ and .NET programmers. The toolkit includes complete source code to create a library that will read and write 3DM files. The toolkit also includes source code for several example programs. - For more information, see ["What is openNURBS?"](https://developer.rhino3d.com/guides/opennurbs/what-is-opennurbs). ## Getting started @@ -35,17 +31,10 @@ For more information, see ["What is openNURBS?"](https://developer.rhino3d.com/g ``` Replace `` with the full path where you installed opennurbs using forward slashes as directory separators. - For example, if opennurbs_public is installed in `C:\dev\faraway\opennurbs_public` and you want to statically link, then the following two lines would be in your stdafx.h file. - - ```cpp - #define OPENNURBS_PUBLIC_INSTALL_DIR "C:/dev/faraway/opennurbs_public" - #include "C:/dev/faraway/opennurbs_public/opennurbs_public.h" -``` - -Please see ["Getting started"](http://developer.rhino3d.com/guides/opennurbs/getting-started/) for more information about openNURBS including supported compilers, build instructions, and a description of the examples. +Please see ["Getting started"](https://developer.rhino3d.com/guides/opennurbs/getting-started/) for more information about openNURBS including supported compilers, build instructions, and a description of the examples. There's also a collection of [example 3dm files](https://www.rhino3d.com/download/opennurbs/6/opennurbs6samples) available for testing. ## Questions? -For technical support, please head over to [Discourse](http://discourse.mcneel.com/category/opennurbs). +For technical support, please head over to [Discourse](https://discourse.mcneel.com/category/opennurbs). From efe48fff41a330f373eab54dfa9ebbe18792fc1a Mon Sep 17 00:00:00 2001 From: Will Pearson Date: Wed, 17 Oct 2018 00:27:04 +0100 Subject: [PATCH 2/3] Remove redundant license info from readme The license itself makes all of this clear --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index 36443f8f..97e9cf9f 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,6 @@ The openNURBS Initiative provides CAD, CAM, CAE, and computer graphics software The openNURBS Toolkit consists of C++ source code for a library that will read and write openNURBS 3D model files (_.3dm_). More than 400 software development teams and applications, including [_Rhinoceros®_](https://rhino3d.com), exchange 3D models using the openNURBS file format. Additionally, the Toolkit provides NURBS evaluation tools and elementary geometric and 3D view manipulation tools as well as including source code for several example programs. -Unlike other open development initiatives, alliances, or consortia: - -* Commercial use is encouraged. -* The tools, support, and membership are free. -* There are no restrictions. Neither copyright nor copyleft restrictions apply. -* No contribution of effort or technology is required from the members, although it is encouraged. - For more information, see ["What is openNURBS?"](https://developer.rhino3d.com/guides/opennurbs/what-is-opennurbs). ## Getting started From 9f96d90426cafee0258fffebbd54e88d0bdfc8f7 Mon Sep 17 00:00:00 2001 From: Will Pearson Date: Wed, 17 Oct 2018 00:28:14 +0100 Subject: [PATCH 3/3] Fix indentation in readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 97e9cf9f..35157e4e 100644 --- a/README.md +++ b/README.md @@ -15,14 +15,14 @@ For more information, see ["What is openNURBS?"](https://developer.rhino3d.com/g 3. Create your C++ project that will use opennurbs. 4. In your project's stdafx.h, put the following lines: - ```cpp - // defining OPENNURBS_PUBLIC_INSTALL_DIR enables automatic linking using pragmas - #define OPENNURBS_PUBLIC_INSTALL_DIR "" - // uncomment the next line if you want to use opennurbs as a DLL - //#define OPENNURBS_IMPORTS - #include "/opennurbs_public.h" - ``` - Replace `` with the full path where you installed opennurbs using forward slashes as directory separators. + ```cpp + // defining OPENNURBS_PUBLIC_INSTALL_DIR enables automatic linking using pragmas + #define OPENNURBS_PUBLIC_INSTALL_DIR "" + // uncomment the next line if you want to use opennurbs as a DLL + //#define OPENNURBS_IMPORTS + #include "/opennurbs_public.h" + ``` + Replace `` with the full path where you installed opennurbs using forward slashes as directory separators. Please see ["Getting started"](https://developer.rhino3d.com/guides/opennurbs/getting-started/) for more information about openNURBS including supported compilers, build instructions, and a description of the examples.