diff --git a/Documentation/Release Notes/v0.9.0.md b/Documentation/Release Notes/v0.9.0.md new file mode 100644 index 00000000..f8e86ace --- /dev/null +++ b/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 diff --git a/Documentation/Release Notes/v0.9.2.md b/Documentation/Release Notes/v0.9.2.md deleted file mode 100644 index 7396dc40..00000000 --- a/Documentation/Release Notes/v0.9.2.md +++ /dev/null @@ -1 +0,0 @@ -TODO: v0.9.2 diff --git a/Documentation/Release Notes/v1.0.0-alpha.1.md b/Documentation/Release Notes/v1.0.0-alpha.1.md index cf440623..bfdf0cae 100644 --- a/Documentation/Release Notes/v1.0.0-alpha.1.md +++ b/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. diff --git a/Documentation/overview.md b/Documentation/overview.md index 57bc1342..71ddd48f 100644 --- a/Documentation/overview.md +++ b/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 diff --git a/Documentation/release-notes.md b/Documentation/release-notes.md index b401fa69..bdb259bc 100644 --- a/Documentation/release-notes.md +++ b/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. diff --git a/Graphics/Logo/FullWhite.png b/Graphics/Logo/FullWhite.png new file mode 100644 index 00000000..d2c4f6dc Binary files /dev/null and b/Graphics/Logo/FullWhite.png differ diff --git a/Graphics/Logo/Logo.pdf b/Graphics/Logo/Logo.pdf index b92e3499..47ad912b 100644 Binary files a/Graphics/Logo/Logo.pdf and b/Graphics/Logo/Logo.pdf differ