27 Commits

Author SHA1 Message Date
Graham Pentheny
04ea2a57b1
Update README.md 2022-11-25 21:45:32 -05:00
Graham Pentheny
5f642c5e5c Updated readme with better grammar and high-level overview 2022-11-25 21:44:54 -05:00
Graham Pentheny
250c3041ce Added development roadmap 2022-11-25 21:38:11 -05:00
Graham Pentheny
2b0c244d12
Updated doxygen output (#581)
- Upgraded doxyfile to latest format
- Fixed a bunch of warnings and errors in docstrings that doxygen was complaining about
- Added the doxygen-awesome theme to modernize the output
- Removed a duplicate screenshot we'd had in the docs folder
- Moved the RecastDemo screenshot into the Docs/images folder
- Changed the doxygen main page to be the README.md since the dedicated main page file we had was nearly identical but out of date
- Added CONTRIBUTING.md so it's part of the generated doxygen output
- Removed duplicate license file to avoid confusion
- Combined the FAQ with the Recast_api.txt, since the FAQ was essentially just better docs for the members of `rcConfig`
2022-11-23 00:13:38 -05:00
Graham Pentheny
b1e04cf59c
Updated build badges in Readme to use workflows 2022-11-12 13:37:41 -05:00
Graham Pentheny
17a19d0e82
Simplified macOS Build Process (#579)
This makes the default xcode project generated by premake work out of the box, and is generally easier for mac users.  Especially those who don't have permissions to modify /Library/Frameworks/

- Look for SDL in RecastDemo/Bin by default rather than /Library/Frameworks/
- Updated README build instructions
- Ignore SDL2.framework in RecastDemo/Bin
2022-11-11 21:04:29 -05:00
grdowns
a425d03b0e Add vcpkg installation instructions 2022-10-11 23:48:55 -04:00
Graham Pentheny
c187b7e88b
Removed broken IssueStats badges from README.md 2022-06-03 02:56:44 -04:00
Jakob Botsch Nielsen
ec05c9e17c
Update build instructions for Windows 2020-11-19 14:23:59 +01:00
Dig-Doug
eecb7f45ec Updates the README instructions for linux
The binary has to be run from the bin directory, otherwise the DroidSans font can't be found and shows the error "Could not init GUI renderer.":

https://github.com/recastnavigation/recastnavigation/blob/master/RecastDemo/Source/main.cpp#L129
2020-08-05 22:50:04 +02:00
Peter Boyer
c4ad0b2eb4 Fix for typo
We shouldn't leave such a shocking typo on such a nice description, now should we? ;)
2018-06-16 11:35:24 +02:00
but0n
494c2967a7 doc: fix typo SDl 2018-03-04 14:10:28 +01:00
Graham Pentheny
c464d91fe8 Updated some old documentation (#209) 2016-06-08 11:06:01 -04:00
Ben Hymers
f0c09d7583 Add CONTRIBUTING.md
Contains a first pass of contributing guidelines and code of conduct

Fix #174
2016-02-09 17:52:55 +00:00
Ben Hymers
5d58cf40c1 Add Issue Stats badges to README.md
The readme was looking lonely after the BitDeli badge was taken away. Here are some nice badges to replace it, which also helpfully show how active a project this has become! They show recent average time to close issues and PRs.
2016-01-15 00:40:33 +00:00
Ben Hymers
f22f431a90 Remove BitDeli badge from README.md
It appears that BitDeli is defunct; their website has had a banner about a change in the GitHub API for a long time, which is a dead link to a blog article, and none of the example stats have been updated for years. Let's just remove it!
2016-01-14 23:43:19 +00:00
Graham Pentheny
512ec1fdfd Unit testing framework.
* Tests live in a "Tests" folder alongside the other components.  Inside the "Tests" folder, tests are split into folders by the component they test.  For example, the example unit test of "rcVdot" (which is implmemented in Recast/Recast.h) lives in "Tests/Recast/Tests_Recast.h".
* Uses the Catch testing framework
* One example test of "rcVdot"
* Tests are run on Travis and Appveyor after every build.  Failing unit tests will fail the build in both case.
* Added instructions on running unit tests to the readme
2016-01-06 18:22:39 -05:00
Graham Pentheny
2eb3abfb60 Updated RecastDemo to SDL2
* Renamed a bunch of variables in main.cpp to be more descriptive.
* Removed unnecessary SDLMain.h and SDLMain.m OSX objective-c class as well as the plist, strings, xib and icns files, which are not needed.
* included cstdio in imguiRenderGL since SDL2 doesn't do it for us.
* Updated premake5 script to support SDL2 and to set the debug directory, as well as copy the SDL2.dll to the target directory on Windows.
* Updated readme with more descriptive, platform-specific demo project setup instructions
* Updated appveyor build script to build vs2015 as well.
* Updated Travis build script to build SDL2 from source, because they use Ubuntu 12.04 which doesn't have the libsdl2-dev package in its repositories.
2016-01-04 18:56:51 -05:00
Ben Hymers
e2f13c2bab Set AppVeyor and Travis CI badges to recastnavigation repo in README 2015-12-16 02:06:16 +00:00
Ben Hymers
e558e98592 Add AppVeyor and Travis CI build scripts
Build scripts download SDL, download (or build) premake5, generate projects, then build, in several configurations and platforms

Project now builds with premake5 instead of premake4 to allow VS2015 project generation
Tweaked SDL directory dependency to work better with CI
Update README
2015-12-16 01:33:18 +00:00
Mikko Mononen
1dd5cf1883 Updated readme to explain which SDL dll to use on windows. 2015-06-22 18:49:53 +03:00
Nightblade
10007a0843 Update README.md
Fixed 3 typos.
2014-05-19 21:04:22 +10:00
Mikko Mononen
eec40309bc Updates for readme 2013-10-01 22:26:39 +02:00
Mikko Mononen
be4d6fc180 Updated build system to premake4 2013-10-01 19:53:18 +02:00
Mikko Mononen
00fcf075af Bitdeli badge 2013-09-16 21:29:57 +02:00
Mikko Mononen
7b065f5e0c Actually update README.md 2013-09-15 21:08:19 +02:00
Mikko Mononen
0f47222795 Updated readme
- added README.md
- moved old release notes to wiki
- removed TODO.txt
- remove old readme
- added more stuff to .gitingore
2013-09-15 20:50:28 +02:00