From a2ef5a53a2b8fbccea1a85994cd6930abf54ea75 Mon Sep 17 00:00:00 2001 From: kevindlewis23 <55998034+kevindlewis23@users.noreply.github.com> Date: Fri, 7 Jun 2024 14:19:01 -0400 Subject: [PATCH] Update README.md --- ik_python/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ik_python/README.md b/ik_python/README.md index 73115a3..d585749 100644 --- a/ik_python/README.md +++ b/ik_python/README.md @@ -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 @@ -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