Skip to content

Commit

Permalink
Updated readme + add BSD-3 licence file.
Browse files Browse the repository at this point in the history
  • Loading branch information
sebcrozet committed Jul 24, 2013
1 parent d2fe57b commit 46b0dfe
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 18 deletions.
27 changes: 27 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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::<f32>([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:
Expand All @@ -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
Expand Down

0 comments on commit 46b0dfe

Please sign in to comment.