Fix typoes in readme
parent
7bcb506d98
commit
0f4c69e2ce
11
README.md
11
README.md
|
@ -20,18 +20,17 @@
|
|||
< ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS >
|
||||
< FOR A PARTICULAR PURPOSE. See GNU General Public License for details. -->
|
||||
|
||||
|
||||
# Getting started
|
||||
# Get started
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
Then use these commands to build and run an example:
|
||||
|
||||
```
|
||||
``` bash
|
||||
cmake -E make_directory build
|
||||
cmake -E chdir build cmake -DCMAKE_BUILD_TYPE=Release ..
|
||||
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:
|
||||
|
||||
> `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.
|
||||
|
||||
|
@ -55,6 +54,6 @@ Take a look at the `examples` folder in this repo and have fun. File a request i
|
|||
You are very welcome to:
|
||||
|
||||
- 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
|
||||
- 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.
|
Loading…
Reference in New Issue