Skip to content

Commit fe5b6e8

Browse files
Merge pull request #7 from Michi-Tsubaki/tsubaki/ros-pubsub
ROJ --> RobotJuliaClient
2 parents 84fb13f + 690a533 commit fe5b6e8

16 files changed

+49
-49
lines changed

.github/workflows/front-github-actions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,4 @@ jobs:
9999
files: ./lcov.info
100100
flags: unittests
101101
name: codecov-umbrella
102-
fail_ci_if_error: false
102+
fail_ci_if_error: false

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name = "ROJ"
1+
name = "RobotJuliaClient"
22
uuid = "493365b4-7e18-460b-8b90-ec3e7f80d3eb"
33
authors = ["Michi-Tsubaki <michi.tsubaki.tech@gmail.com>"]
44
version = "0.1.0"

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# ROJ.jl
1+
# RobotJuliaClient.jl
22

3-
ROJ (ROS2 on Julia) is a Julia wrapper for ROS2's Python client library (rclpy). It provides a Julia-friendly interface for ROS2 functionality while leveraging the robust features of rclpy.
3+
RobotJuliaClient (ROS2 on Julia) is a Julia wrapper for ROS2's Python client library (rclpy). It provides a Julia-friendly interface for ROS2 functionality while leveraging the robust features of rclpy.
44

55
[日本語のREADMEはこちら](#rojjl-1)
66

@@ -31,7 +31,7 @@ ROJ (ROS2 on Julia) is a Julia wrapper for ROS2's Python client library (rclpy).
3131

3232
### Version Compatibility
3333

34-
| ROJ.jl Version | ROS2 Version | Julia Version | Python Version |
34+
| RobotJuliaClient.jl Version | ROS2 Version | Julia Version | Python Version |
3535
|----------------|--------------|---------------|----------------|
3636
| 0.1.x | Jazzy | 1.10+ | 3.12 |
3737

@@ -42,18 +42,18 @@ ROJ (ROS2 on Julia) is a Julia wrapper for ROS2's Python client library (rclpy).
4242
source /opt/ros/$ROS_DISTRO/setup.bash
4343
```
4444

45-
2. Install ROJ.jl:
45+
2. Install RobotJuliaClient.jl:
4646
```julia
4747
using Pkg
48-
Pkg.add(url="https://github.com/your-username/ROJ.jl")
48+
Pkg.add(url="https://github.com/your-username/RobotJuliaClient.jl")
4949
```
5050

5151
## Usage
5252

5353
### Basic Example
5454

5555
```julia
56-
using ROJ
56+
using RobotJuliaClient
5757

5858
# Create a node
5959
node = ROSNode("example_node")
@@ -100,21 +100,21 @@ Check the `examples/` directory for more detailed examples:
100100

101101
## Notes
102102

103-
1. Always source ROS2 environment before using ROJ:
103+
1. Always source ROS2 environment before using RobotJuliaClient:
104104
```bash
105105
source /opt/ros/$ROS_DISTRO/setup.bash
106106
```
107107

108-
2. When using ROJ in a ROS2 package:
109-
- Add ROJ as a dependency in your package.xml
108+
2. When using RobotJuliaClient in a ROS2 package:
109+
- Add RobotJuliaClient as a dependency in your package.xml
110110
- Configure your CMakeLists.txt to include Julia files
111111
- Run `colcon build` to build your package
112112

113-
3. ROJ requires Python with rclpy installed and properly configured
113+
3. RobotJuliaClient requires Python with rclpy installed and properly configured
114114

115115
## Contributing
116116

117-
We warmly welcome contributions to ROJ.jl! Whether it's bug fixes, new features, documentation improvements, or example code, your help is appreciated.
117+
We warmly welcome contributions to RobotJuliaClient.jl! Whether it's bug fixes, new features, documentation improvements, or example code, your help is appreciated.
118118

119119
### Ways to Contribute
120120

@@ -152,8 +152,8 @@ We warmly welcome contributions to ROJ.jl! Whether it's bug fixes, new features,
152152

153153
```bash
154154
# Clone the repository
155-
git clone https://github.com/your-username/ROJ.jl
156-
cd ROJ.jl
155+
git clone https://github.com/your-username/RobotJuliaClient.jl
156+
cd RobotJuliaClient.jl
157157

158158
# Add the package in development mode
159159
julia -e 'using Pkg; Pkg.develop(path=".")'
@@ -179,9 +179,9 @@ This project is licensed under the MIT License - see the LICENSE file for detail
179179

180180
---
181181

182-
# ROJ.jl
182+
# RobotJuliaClient.jl
183183

184-
ROJ (ROS2 on Julia)は、ROS2のPythonクライアントライブラリ(rclpy)のJuliaラッパーです。rclpyの堅牢な機能を活用しながら、JuliaフレンドリーなインターフェースでROS2の機能を提供します。
184+
RobotJuliaClient (ROS2 on Julia)は、ROS2のPythonクライアントライブラリ(rclpy)のJuliaラッパーです。rclpyの堅牢な機能を活用しながら、JuliaフレンドリーなインターフェースでROS2の機能を提供します。
185185

186186
## 機能
187187

@@ -210,7 +210,7 @@ ROJ (ROS2 on Julia)は、ROS2のPythonクライアントライブラリ(rclpy
210210

211211
### バージョン互換性
212212

213-
| ROJ.jl バージョン | ROS2 バージョン | Julia バージョン | Python バージョン |
213+
| RobotJuliaClient.jl バージョン | ROS2 バージョン | Julia バージョン | Python バージョン |
214214
|------------------|----------------|-----------------|------------------|
215215
| 0.1.x | Jazzy | 1.10以上 | 3.12 |
216216

@@ -221,18 +221,18 @@ ROJ (ROS2 on Julia)は、ROS2のPythonクライアントライブラリ(rclpy
221221
source /opt/ros/$ROS_DISTRO/setup.bash
222222
```
223223

224-
2. ROJ.jlのインストール:
224+
2. RobotJuliaClient.jlのインストール:
225225
```julia
226226
using Pkg
227-
Pkg.add(url="https://github.com/your-username/ROJ.jl")
227+
Pkg.add(url="https://github.com/your-username/RobotJuliaClient.jl")
228228
```
229229

230230
## 使用方法
231231

232232
### 基本例
233233

234234
```julia
235-
using ROJ
235+
using RobotJuliaClient
236236

237237
# ノードの作成
238238
node = ROSNode("example_node")
@@ -279,21 +279,21 @@ end
279279

280280
## 注意点
281281

282-
1. ROJを使用する前に必ずROS2環境を読み込んでください
282+
1. RobotJuliaClientを使用する前に必ずROS2環境を読み込んでください
283283
```bash
284284
source /opt/ros/$ROS_DISTRO/setup.bash
285285
```
286286

287-
2. ROS2パッケージでROJを使用する場合
288-
- package.xmlにROJを依存関係として追加
287+
2. ROS2パッケージでRobotJuliaClientを使用する場合
288+
- package.xmlにRobotJuliaClientを依存関係として追加
289289
- CMakeLists.txtでJuliaファイルを含むように設定
290290
- `colcon build`でパッケージをビルド
291291

292-
3. ROJには、rclpyがインストールされ、適切に設定されたPythonが必要です
292+
3. RobotJuliaClientには、rclpyがインストールされ、適切に設定されたPythonが必要です
293293

294294
## 貢献について
295295

296-
ROJ.jlへの貢献を歓迎します!バグ修正、新機能、ドキュメントの改善、サンプルコードなど、あらゆる形の協力を感謝します。
296+
RobotJuliaClient.jlへの貢献を歓迎します!バグ修正、新機能、ドキュメントの改善、サンプルコードなど、あらゆる形の協力を感謝します。
297297

298298
### 貢献の方法
299299

@@ -331,8 +331,8 @@ ROJ.jlへの貢献を歓迎します!バグ修正、新機能、ドキュメ
331331

332332
```bash
333333
# リポジトリをクローン
334-
git clone https://github.com/your-username/ROJ.jl
335-
cd ROJ.jl
334+
git clone https://github.com/your-username/RobotJuliaClient.jl
335+
cd RobotJuliaClient.jl
336336

337337
# パッケージを開発モードで追加
338338
julia -e 'using Pkg; Pkg.develop(path=".")'

examples/example_service_client.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env julia
22
# example_service_client.jl
33

4-
using ROJ
4+
using RobotJuliaClient
55

66
function main()
77
println("Creating node...")

examples/example_service_server.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env julia
22
# example_service_server.jl
3-
using ROJ
3+
using RobotJuliaClient
44
using PyCall
55

66
function add_service_callback(request, response)

examples/pose_publisher.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env julia
22

33
# pose_publisher.jl
4-
using ROJ
4+
using RobotJuliaClient
55

66
function main()
77
# Creating node

examples/pose_subscriber.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env julia
22

33
# pose_subscriber.jl
4-
using ROJ
4+
using RobotJuliaClient
55

66
function int_callback(msg)
77
println("Received counter: $(msg.data)")

examples/simple_pub_sub.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env julia
22

33
# simple_pub_sub.jl
4-
using ROJ
4+
using RobotJuliaClient
55

66
function main()
77
# Creating node

examples/simple_publisher.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# simple_publisher.jl
33
# description: sample publishing code
44

5-
using ROJ
5+
using RobotJuliaClient
66

77
function main()
88
# Creating node

examples/simple_subscriber.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env julia
22
# simple_subscriber.jl
33
# description : sample subscription code
4-
using ROJ
4+
using RobotJuliaClient
55

66
function callback(msg)
77
println("Subscribed: ", msg.data)

0 commit comments

Comments
 (0)