104 make the readme shine before opening the repo #105
Conversation
RemiFabre
requested review from
Drenayaz
and removed request for
FabienDanieau
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
LICENSE
Outdated
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright [yyyy] [name of copyright owner] |
There was a problem hiding this comment.
2025 Pollen Robotics
docs/img/topgrasp.gif
Outdated
There was a problem hiding this comment.
this should be tracked by lfs
| @@ -12,8 +54,29 @@ Use the following command to install: | |||
| ```console | |||
| $ pip install -e .[dev] | |||
There was a problem hiding this comment.
pip install -e . provides
numpy >= 1.24
scipy == 1.8.0
matplotlib == 3.5.1
meshcat == 0.3.2
types-protobuf == 5.27.0.20240626
Is everything needed for simply running the IK? For instance matplotlib seems to be used for plotting graph.
If relevant, you may want to add another optional requirements dependency (like [dev]). Typically in the docker image in production we just need the minimum to run the IK.
README.md
Outdated
| ## Usage | ||
| Basic example of an inverse kinematics call. The input is a Pose of dimension 6, the output is the 7 joints of the arm: | ||
| ```python | ||
| symbolic_ik = SymbolicIK(arm="l_arm") |
There was a problem hiding this comment.
import is missing
the new user is going to copy and paste this
There was a problem hiding this comment.
Cleaning up imports, requirements and examples will be done by @Drenayaz
Thanks for the inputs Fabien!
|
Everything has been done, merging |
RemiFabre
deleted the
104-make-the-readme-shine-before-opening-the-repo
branch
Tried some README improvements before publishing. Is this style OK?
Added a License, a description, a list of features, some visuals and a short example