Skip to content

Commit deaec62

Browse files
authored
Update README.md
1 parent e7ac5b6 commit deaec62

File tree

1 file changed

+7
-31
lines changed

1 file changed

+7
-31
lines changed

README.md

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# :robot: Robot Library :open_book:
22

3-
Robot Library is a C++ package for modeling, trajectory generation, and control of robots. The [initial release](#package-release-notes---v100-april-2025) supports real-time velocity control of serial link robot arms (work on torque control is underway!). Checkout the [ROS2 action server](https://github.com/Woolfrey/server_serial_link) to see it in action :boom:
3+
Robot Library is a C++ package for modeling, trajectory generation, and control of robots. The current release now supports torque control of robot arms. Check out these repositories for implementations of:
4+
- [Velocity control](https://github.com/Woolfrey/control_serial_link_velocity), or
5+
- [Torque control](https://github.com/Woolfrey/control_kuka_torque).
46

57
#### :sparkles: Features:
68
- _Everything_ is contained in _one_ library: modeling, control, _and_ trajectory generation.
@@ -21,7 +23,6 @@ Robot Library is a C++ package for modeling, trajectory generation, and control
2123
- [Using Robot Library](#rocket-using-robot-library)
2224
- [In Another Project](#in-another-project)
2325
- [Examples](#examples)
24-
- [Release Notes](#package-release-notes---v100-april-2025)
2526
- [Contributing](#handshake-contributing)
2627
- [Citing this Repository](#bookmark_tabs-citing-this-repository)
2728
- [License](#scroll-license)
@@ -168,31 +169,6 @@ If you would like to see examples where `RobotLibrary` has been applied, you can
168169
- [TestingRobotLibrary](https://github.com/Woolfrey/testing_robot_library) : C++ executables I use for numerical validation of RobotLibrary.
169170

170171
[:top: Back to Top.](#robot-robot-library-open_book)
171-
172-
## :package: Release Notes - v1.0.0 (April 2025)
173-
174-
### :tada: Initial Release:
175-
- Control:
176-
- SerialLinkBase : Base class providing common structure for all child classes.
177-
- SerialKinematicControl : Joint velocity & Cartesian velocity control algorithms.
178-
- Math:
179-
- MathFunctions : Helper functions for other classes.
180-
- Polynomial : Generates a scalar, polynomial function.
181-
- SkewSymmetric: Converted an `Eigen::Vector3d` object to an anti-symmetric `Eigen::Matrix3d` object.
182-
- Spline : Connects multiple points using polynomials, whilst ensuring continuity.
183-
- Model:
184-
- Joint : Models an actuated joint on a robot.
185-
- KinematicTree : Kinematic & dynamic modeling of branching, serial-link structures.
186-
- Link : Represents a combined `Joint` and `RigidBody` object.
187-
- Pose : Position and orientation; $\mathbb{SE}(3)$.
188-
- RigidBody : Dynamics for a single, solid object.
189-
- Trajectory:
190-
- CartesianSpline : Generates smooth trajectories over a series of poses.
191-
- SplineTrajectory : Generates smooth trajectories over a series of points.
192-
- TrajectoryBase : Provides common structure to all trajectory classes.
193-
- TrapezoidalVelocity : Trajectory with constant sections, and ramps up and down.
194-
195-
[:top: Back to Top.](#robot-robot-library-open_book)
196172

197173
## :handshake: Contributing
198174

@@ -213,16 +189,16 @@ Here's a BibTeX reference:
213189
```
214190
@software{woolfrey_robot_library_2025
215191
author = {Woolfrey, Jon},
216-
month = apr,
192+
month = aug,
217193
title = {{R}obot {L}ibrary},
218194
url = {https://github.com/Woolfrey/software_robot_library},
219-
version = {1.0.0},
195+
version = {1.2.0},
220196
year = {2025}
221197
}
222198
```
223199
Here's the automatically generated APA format:
224200
```
225-
Woolfrey, J. (2025). Robot Library (Version 1.0.0). Retrieved from https://github.com/Woolfrey/software_robot_library
201+
Woolfrey, J. (2025). Robot Library (Version 1.2.0). Retrieved from https://github.com/Woolfrey/software_robot_library
226202
```
227203

228204
[:top: Back to Top.](#robot-robot-library-open_book)
@@ -231,7 +207,7 @@ Woolfrey, J. (2025). Robot Library (Version 1.0.0). Retrieved from https://githu
231207

232208
This project is licensed under an **Open Source / Commercial Use License (OSCL)**. You are free to use, modify, and (re)distribute this software at no cost under the following conditions:
233209

234-
- You may incorporate this software into your own project, as long as your project also remains free and open source, in accordance with an [OSI-approved open-source license](https://opensource.org/licenses).
210+
- You may incorporate this software into your own project, as long as your project also remains free and open source.
235211
- You may use this software in a closed-source, proprietary, or commercial product or service, _but_ you must obtain a commercial license. Please contact [[email protected]](mailto:[email protected]) to discuss licensing terms and royalties.
236212

237213
This license is designed to encourage open collaboration — but if you profit, then so must I (if only a little :pinching_hand:). See the full [LICENSE](./LICENSE) for complete terms.

0 commit comments

Comments
 (0)