Skip to content

Commit

Permalink
Updated documentation topics, added white version of logo
Browse files Browse the repository at this point in the history
  • Loading branch information
Robmaister committed Jan 14, 2015
1 parent 65a0989 commit aa18b31
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 4 deletions.
15 changes: 15 additions & 0 deletions Documentation/Release Notes/v0.9.0.md
@@ -0,0 +1,15 @@
SharpNav v0.9.0
===============

v0.9.0 was released on October 11, 2014 and is the first publicly released
versions of SharpNav. Due to packaging issues, there are two other versions
available on NuGet - v0.9.1 and v0.9.2.

v0.9.1 and v0.9.2 only differ from v0.9.0 in packaging on NuGet. The
assemblies are still versioned as v0.9.0, though.

## Known Issues

- Bug(s) that prevent proper triangulation in `PolyMeshDetail`
- Excessive memory usage in rare cases
- Unfinished public APIs, though the `SharpNav` namespace is mostly stable
1 change: 0 additions & 1 deletion Documentation/Release Notes/v0.9.2.md

This file was deleted.

35 changes: 34 additions & 1 deletion Documentation/Release Notes/v1.0.0-alpha.1.md
@@ -1 +1,34 @@
TODO v1.0.0-alpha.1
v1.0.0-alpha.1
==============

v1.0.0-alpha.1 was released on December 31, 2014. It is the second release of
SharpNav and the first pre-release of v1.0.0. It fixes several bugs from
v0.9.0 and makes several changes to the public API.

## Major Changes

- Removed existing but broken XNA and Unity3D builds.
- Raw contour vertices are no longer stored in the `Contour` class.
- SharpNav now relies on NuGet to retrieve packages.

## Minor Changes

- The `RegionId` enum is now the `Region` struct.
- The `AreaId` enum is now the `Area` struct.
- All vector types are now in the `SharpNav.Geometry` namespace in the
Standalone build.
- The `ContourSet` constructor no longer takes a `CompactHeightfield` as a
parameter. It is instead handled in `CompactHeightfield.BuildContourSet`.

## Bugfixes

- Fixed incorrect slope calculation in `AreaIdGenerator`.
- Fixed most bugs preventing proper triangulation in `PolyMeshDetail`.
- Fixed thread safety issue with triangle rasterization in `Heightfield`.

## Known Issues

- With enough detail, `PolyMeshDetail` will still produce incorrectly
triangulated meshes.
- Edge cases consuming a lot of memory likely still exist.
- public APIs are still unfinished.
8 changes: 7 additions & 1 deletion Documentation/overview.md
@@ -1 +1,7 @@
TODO Overview
Overview
========

SharpNav is a navigation mesh generation and pathfinding library. It started
as a port of Mikko Monomen's [Recast Navigation][1] to C#.

[1]: https://github.com/memononen/recastnavigation
6 changes: 5 additions & 1 deletion Documentation/release-notes.md
@@ -1 +1,5 @@
TODO: Release Notes
Release Notes
=============

Every publicly released version of SharpNav includes a changelog and other
miscellaneous information about itself.
Binary file added Graphics/Logo/FullWhite.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Graphics/Logo/Logo.pdf
Binary file not shown.

0 comments on commit aa18b31

Please sign in to comment.