turtlebasket
/
openGJK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typoes in readme

fixes-turtlebasket
Mattia Montanari 2023-04-15 15:46:11 +02:00
parent 7bcb506d98
commit 0f4c69e2ce
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -20,18 +20,17 @@
< ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS > < ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS >
< FOR A PARTICULAR PURPOSE. See GNU General Public License for details. --> < FOR A PARTICULAR PURPOSE. See GNU General Public License for details. -->
# Get started
# Getting started
On Linux, Mac or Windows, if you have a basic C/C++ toolchain installed (git, compiler and cmake) clone this repo: On Linux, Mac or Windows, if you have a basic C/C++ toolchain installed (git, compiler and cmake) clone this repo:
``` ``` bash
git clone https://github.com/MattiaMontanari/openGJK.git git clone https://github.com/MattiaMontanari/openGJK.git
``` ```
Then use these commands to build and run an example: Then use these commands to build and run an example:
``` ``` bash
cmake -E make_directory build cmake -E make_directory build
cmake -E chdir build cmake -DCMAKE_BUILD_TYPE=Release .. cmake -E chdir build cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build build cmake --build build
@ -40,7 +39,7 @@ cmake -E chdir build/examples/c ./example_lib_opengjk_ce
If you get no errors, the successfull output is: If you get no errors, the successfull output is:
> `Distance between bodies 3.653650`. > `Distance between bodies 3.653650`
However, if you do get an error - any error - please file a bug! Support requests are welcome too. However, if you do get an error - any error - please file a bug! Support requests are welcome too.
@ -48,13 +47,13 @@ However, if you do get an error - any error - please file a bug! Support request
The best source to learn how to use OpenGJK are the examples. They are listed [here](https://www.mattiamontanari.com/opengjk/docs/examples/) for C, C#, Go, Matlab and Python. I aim to publish few more for Julia and Unity. The best source to learn how to use OpenGJK are the examples. They are listed [here](https://www.mattiamontanari.com/opengjk/docs/examples/) for C, C#, Go, Matlab and Python. I aim to publish few more for Julia and Unity.
Take a look at the `examples` folder in this repo and have fun. File a request if you wish to see more! Take a look at the `examples` folder in this repo and have fun. File a request if you wish to see more!
# Contribute # Contribute
You are very welcome to: You are very welcome to:
- Create pull requests of any kind - Create pull requests of any kind
- Let me know if you are using this library and find it usefule - Let me know if you are using this library and find it useful
- Open issues with request for support because they will help you and many others - Open issues with request for support because they will help you and many others
- Cite this repository ([a sweet GitHub feature](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#about-citation-files)) or my paper: Montanari, M. et at, *Improving the GJK Algorithm for Faster and More Reliable Distance Queries Between Convex Objects* (2017). ACM Trans. Graph. - Cite this repository ([a sweet GitHub feature](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#about-citation-files)) or my paper: Montanari, M. et at, *Improving the GJK Algorithm for Faster and More Reliable Distance Queries Between Convex Objects* (2017). ACM Trans. Graph.