Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #5

Merged
merged 1 commit into from
Feb 4, 2024
Merged

Update README.md #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"files.trimFinalNewlines": true,
"editor.defaultFormatter": "redhat.vscode-xml",
},
"uncrustify.executablePath.linux": "/usr/bin/uncrustify",
"uncrustify.configPath.linux": ".vscode/uncrustify.cfg",
"xml.format.splitAttributes": true,
"files.associations": {
Expand Down
31 changes: 29 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
# chatgpt_ros_cpp

ROS 2 service for ChatGPT API written in c++
ROS 2 service for ChatGPT API written in C++

## Usage
[![ci_humble](https://github.com/MrBearing/chatgpt_ros_cpp/actions/workflows/ci_humble.yaml/badge.svg)](https://github.com/MrBearing/chatgpt_ros_cpp/actions/workflows/ci_humble.yaml)

### Locate package in workspace

```bash
mkdir -p ~/ws_ros2/src
cd ~/ws_ros2/src
git clone git@github.com:MrBearing/chatgpt_ros_cpp.git
```

### Run script to install dependencies

```bash
source /opt/ros/$ROS_DISTRO/setup.bash
cd ~/ws_ros2/src/MG400_ROS2
./setup.bash
exec -l $SHELL
```

## Launch node and rqt_service

This command launch chatgpt_ros_cpp_node with rqt_service

``` :bash
source ~/ws_ros2/install/setup.bash
ros2 launch chatgpt_ros_cpp_bringup chat.launch.py api_key:="YOUR_OPEN_AI_API_KEY"

```


## Reference

- [OpenAI api reference](https://platform.openai.com/docs/api-reference/chat/create)
Loading