Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kevindlewis23 authored Jun 7, 2024
1 parent 9ccdb59 commit a2ef5a5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions ik_python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This is a python api for the rust implementation of inverse kinematics using PyO

This requires [PyO3 maturin](https://pyo3.rs/v0.21.2/) to be installed.

In the ik_python directory, you can run this to install it:
In the `ik_python` directory, you can run this to install it:
```bash
python -m venv .env
source .env/bin/activate
Expand All @@ -21,8 +21,8 @@ Outisde of the virtual environment, you can use the following command to build a

## To use

Import the ik_python package into your code
Import the `ik_python` package in your code

The API documentation is at ik_python.pyi, and there will be typechecking with mypy installed.
The API documentation is at `ik_python.pyi`, and there will be typechecking with mypy installed.

Look at examples/sample.py for sample usage
Look at `examples/sample.py` for sample usage

0 comments on commit a2ef5a5

Please sign in to comment.