Add proper readme and license

Fixes RH-48845
This commit is contained in:
Will Pearson
2018-10-10 23:28:56 +01:00
parent 80b0545f2b
commit 302a631acd
3 changed files with 97 additions and 90 deletions

48
LICENSE Normal file
View File

@@ -0,0 +1,48 @@
Copyright (c) 1993-2018 Robert McNeel & Associates. All Rights Reserved.
Rhinoceros is a registered trademark of Robert McNeel & Associates.
THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED
WARRANTY. ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR
PURPOSE AND OF MERCHANTABILITY ARE HEREBY DISCLAIMED.
The openNURBS toolkit uses zlib for mesh and bitmap compression.
The zlib source code distributed with openNURBS is a subset of what
is available from zlib. The zlib code itself has not been modified.
See ftp://ftp.freesoftware.com/pub/infozip/zlib/zlib.html for more
details.
Zlib has a generous license that is similar to the one for openNURBS.
The zlib license shown below was copied from the zlib web page
ftp://ftp.freesoftware.com/pub/infozip/zlib/zlib_license.html
on 20 March 2000.
zlib.h -- interface of the 'zlib' general purpose compression library
version 1.1.3, July 9th, 1998
Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
The data format used by the zlib library is described by RFCs (Request for
Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
(zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
# openNURBS
[![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 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.
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.
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
1. Clone this repository.
2. Open opennurbs_public.sln, select the platform and configuration, and rebuild all.
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 "<MY_INSTALLPATH>"
// uncomment the next line if you want to use opennurbs as a DLL
//#define OPENNURBS_IMPORTS
#include "<MY_INSTALLPATH>/opennurbs_public.h"
```
Replace `<MY_INSTALLPATH>` 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.
## Questions?
For technical support, please head over to [Discourse](http://discourse.mcneel.com/category/opennurbs).

View File

@@ -1,90 +0,0 @@
More Information:
Please see
http://developer.rhino3d.com/guides/opennurbs/getting-started/
for information about opennurbs including supported compilers,
build instructions,
and a description of the examples.
Technical support:
http://discourse.mcneel.com/category/opennurbs
Legal Stuff:
The openNURBS Initiative provides CAD, CAM, CAE, and computer
graphics software developers the tools to accurately transfer
3-D geometry between applications.
The tools provided by openNURBS include:
* C++ source code libraries to read and write the file format.
* Quality assurance and revision control.
* Various supporting libraries and utilities.
* Technical support.
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, please see <http://www.openNURBS.org>.
The openNURBS toolkit uses zlib for mesh and bitmap compression.
The zlib source code distributed with openNURBS is a subset of what
is available from zlib. The zlib code itself has not been modified.
See ftp://ftp.freesoftware.com/pub/infozip/zlib/zlib.html for more
details.
Zlib has a generous license that is similar to the one for openNURBS.
The zlib license shown below was copied from the zlib web page
ftp://ftp.freesoftware.com/pub/infozip/zlib/zlib_license.html
on 20 March 2000.
zlib.h -- interface of the 'zlib' general purpose compression library
version 1.1.3, July 9th, 1998
Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
The data format used by the zlib library is described by RFCs (Request for
Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
(zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
Copyright (c) 1993-2018 Robert McNeel & Associates. All Rights Reserved.
Rhinoceros is a registered trademark of Robert McNeel & Associates.
THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED
WARRANTY. ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR
PURPOSE AND OF MERCHANTABILITY ARE HEREBY DISCLAIMED.