Skip to content

Commit 473188e

Browse files
authored
Update README.md
1 parent c6135a3 commit 473188e

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# :robot: Robot Library :open_book:
1+
# :robot: Robot Library
22

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:
3+
Robot Library is a C++ package for modeling, trajectory generation, and control of robots. The current release supports velocity, torque, and (inertia-free) impedance control. Check out the following repositories to see it in action:
44
- [Velocity control](https://github.com/Woolfrey/control_serial_link_velocity), or
5-
- [Torque control](https://github.com/Woolfrey/control_kuka_torque).
5+
- [Impedance control](https://github.com/Woolfrey/control_kuka_impedance).
66

77
#### :sparkles: Features:
88
- _Everything_ is contained in _one_ library: modeling, control, _and_ trajectory generation.
@@ -40,7 +40,7 @@ The diagram below shows how the different libraries interact:
4040
<img src = "doc/interaction.png" width="450" height="auto"/>
4141
</p>
4242

43-
[:top: Back to Top.](#robot-robot-library-open_book)
43+
[:top: Back to Top.](#robot-robot-library)
4444

4545
## :floppy_disk: Installation
4646

@@ -124,7 +124,7 @@ sudo apt install libeigen3-dev
124124

125125
You should now be able to include different parts of the library in your C++ files.
126126

127-
[:top: Back to Top.](#robot-robot-library-open_book)
127+
[:top: Back to Top.](#robot-robot-library)
128128

129129
## :rocket: Using Robot Library
130130

@@ -183,7 +183,7 @@ If you would like to see examples where `RobotLibrary` has been applied, you can
183183
- [Kuka iiwa14 velocity control](https://github.com/Woolfrey/control_kuka_velocity) : a ROS2 package which implements the former action server, and
184184
- [TestingRobotLibrary](https://github.com/Woolfrey/testing_robot_library) : C++ executables I use for numerical validation of RobotLibrary.
185185

186-
[:top: Back to Top.](#robot-robot-library-open_book)
186+
[:top: Back to Top.](#robot-robot-library)
187187

188188
## :handshake: Contributing
189189

@@ -194,29 +194,31 @@ Contributions to this repositore are welcome! Feel free to:
194194

195195
If you're looking for ideas, you can always check the [Issues tab](https://github.com/Woolfrey/software_robot_library/issues) for those with :raising_hand: [OPEN]. These are things I'd like to implement, but don't have time for. It'd be much appreciated, and you'll be tagged as a contributor :sunglasses:
196196

197-
[:top: Back to Top.](#robot-robot-library-open_book)
197+
[:top: Back to Top.](#robot-robot-library)
198198

199199
## :bookmark_tabs: Citing this Repository
200200

201201
If you find this code useful, spread the word by acknowledging it. Click on `Cite this repository` under the **About** section in the top-right corner of this page :arrow_upper_right:.
202202

203203
Here's a BibTeX reference:
204204
```
205-
@software{woolfrey_robot_library_2025
206-
author = {Woolfrey, Jon},
207-
month = aug,
208-
title = {{R}obot {L}ibrary},
209-
url = {https://github.com/Woolfrey/software_robot_library},
210-
version = {1.2.0},
211-
year = {2025}
205+
@misc{woolfrey_robotlibrary_2025,
206+
author = {Woolfrey, Jon},
207+
title = {RobotLibrary},
208+
howpublished = {\url{https://github.com/Woolfrey/software_robot_library}},
209+
note = {Version 2.0.0},
210+
year = {2025},
211+
month = {aug},
212+
day = {11},
213+
orcid = {0000-0001-5926-5669}
212214
}
213215
```
214216
Here's the automatically generated APA format:
215217
```
216-
Woolfrey, J. (2025). Robot Library (Version 1.2.0). Retrieved from https://github.com/Woolfrey/software_robot_library
218+
Woolfrey, J. (2025). Robot Library (Version 2.0.0). Retrieved from https://github.com/Woolfrey/software_robot_library
217219
```
218220

219-
[:top: Back to Top.](#robot-robot-library-open_book)
221+
[:top: Back to Top.](#robot-robot-library)
220222

221223
## :scroll: License
222224

@@ -227,4 +229,4 @@ This project is licensed under an **Open Source / Commercial Use License (OSCL)*
227229

228230
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.
229231

230-
[:top: Back to Top.](#robot-robot-library-open_book)
232+
[:top: Back to Top.](#robot-robot-library)

0 commit comments

Comments
 (0)