Skip to content

Commit d64d3be

Browse files
committed
docs: add requirement for pip, readme installation
1 parent 1d5b440 commit d64d3be

File tree

2 files changed

+88
-1
lines changed

2 files changed

+88
-1
lines changed

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,71 @@ To build the documentation locally:
3939

4040
## Installation
4141

42-
[Installation instructions here]
42+
### Prerequisites
43+
44+
- Ubuntu 24.04 (Noble Numbat)
45+
- Python 3.12
46+
47+
### 1. Install ROS2 Jazzy
48+
49+
Follow the official ROS2 Jazzy installation guide for Ubuntu 24.04:
50+
[ROS2 Jazzy Installation](https://docs.ros.org/en/jazzy/Installation.html)
51+
52+
The recommended method is to use the Debian packages:
53+
```bash
54+
sudo apt update && sudo apt install -y software-properties-common
55+
sudo add-apt-repository universe
56+
sudo apt update && sudo apt install -y curl
57+
sudo curl -sSL https://raw.githubusercontent.com/ros/rosdistro/master/ros.key -o /usr/share/keyrings/ros-archive-keyring.gpg
58+
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ros-archive-keyring.gpg] http://packages.ros.org/ros2/ubuntu $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/ros2.list > /dev/null
59+
sudo apt update
60+
sudo apt install ros-jazzy-desktop
61+
```
62+
63+
### 2. Install Python Dependencies
64+
65+
Install the required Python packages:
66+
```bash
67+
pip3 install -r requirements.txt
68+
```
69+
70+
### 3. Build the ROS2 Workspace
71+
72+
```bash
73+
cd coffee_ws
74+
colcon build
75+
```
76+
77+
### 4. Source the Setup Files
78+
79+
Add the following to your `~/.bashrc` to create a convenient alias for sourcing ROS2:
80+
```bash
81+
echo 'alias ros-source="source /opt/ros/jazzy/setup.bash && source ~/path/to/coffee-budy/coffee_ws/install/setup.bash"' >> ~/.bashrc
82+
source ~/.bashrc
83+
```
84+
85+
Alternatively, you can source the files manually each time:
86+
```bash
87+
source /opt/ros/jazzy/setup.bash
88+
source ~/path/to/coffee-budy/coffee_ws/install/setup.bash
89+
```
90+
91+
### 5. Running Coffee Buddy
92+
93+
First, make sure you've sourced the setup files:
94+
```bash
95+
ros-source
96+
```
97+
98+
To run the head tracking:
99+
```bash
100+
ros2 launch coffee_head all_nodes.launch.py
101+
```
102+
103+
To run the eye visuals:
104+
```bash
105+
ros2 launch coffee_face coffee_eyes.launch.py
106+
```
43107

44108
## Usage
45109

requirements.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Image Processing
2+
opencv-contrib-python==4.11.0.86
3+
numpy==1.26.4
4+
dlib==19.24.6
5+
imutils==0.5.4
6+
mediapipe==0.10.21
7+
8+
# UI Libraries
9+
pygame==2.6.1
10+
PyQt5==5.15.10
11+
pyqtgraph==0.12.0
12+
13+
# Utility Libraries
14+
PyYAML==6.0.1
15+
psutil==5.9.8
16+
matplotlib==3.6.3
17+
18+
# Serial Communication
19+
pyserial==3.5
20+
21+
# For testing
22+
pytest==7.4.4
23+
pytest-cov==4.1.0

0 commit comments

Comments
 (0)