From 46b0dfe80f524ce6df99b6ebb269c6d3fc3d7dd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Crozet?= Date: Wed, 24 Jul 2013 20:49:03 +0200 Subject: [PATCH] Updated readme + add BSD-3 licence file. --- LICENSE | 27 +++++++++++++++++++++++++++ README.md | 29 +++++++++++------------------ 2 files changed, 38 insertions(+), 18 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..f7f80044a --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2013, Sébastien Crozet +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the author nor the names of its contributors may be used + to endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 89745f68a..05107ebae 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ with one-liners. All features are one-liners. - open a window with a default arc-ball camera and a point light. - display boxes, spheres, cones or cylinders. - - change an object's color or texture. - - change an object's transform (we use the **nalgebra** library to do that). + - change an object color or texture. + - change an object transform (we use the **nalgebra** library to do that). An object cannot be scaled though. As an exemple, having a red, rotating cube with the light attached to the camera is as simple as: @@ -33,28 +33,20 @@ use kiss3d::window; fn main() { - do window::Window::spawn |window| + do window::Window::spawn(~"Kiss3d: cube") |window| { - let c = window.add_cube().set_color(1.0, 0.0, 0.0); - - do window.set_loop_callback |_| - { c.transformation().rotate_by(&Vec3::new::([0.0, 0.014, 0.0])) } - + let c = window.add_cube(1.0, 1.0, 1.0).set_color(1.0, 0.0, 0.0); + + do window.set_loop_callback + { c.transformation().rotate_by(&Vec3::new(0.0f64, 0.014, 0.0)) } + window.set_light(window::StickToCamera); } } ``` - -## Won’t -Anything not in the previous list is _not_ supported. -In particular common features like multitexturing, custom shader loading, and coffee -making are not supported and wont be unless someone manages to write them in -one line. Don’t hesitate to contribute =) - ## Compilation -You will need the last rust compiler from the master branch. -I pull the compiler and fix my code almost every day. If you encounter -problems, make sure you have the last version. +You will need the last rust compiler from the `master` branch. +If you encounter problems, make sure you have the last compiler version before creating an issue. The simplest way to build **kiss3d** and all its dependencies is to do a recursive clone: @@ -68,6 +60,7 @@ recursive clone: The last command will compile demos on the `bin` folder. +Use `make doc` to compile the documentation on the `doc` folder. ## Contributions I intend to work on this library to suit my needs only (to write demo for my