File tree Expand file tree Collapse file tree 2 files changed +54
-55
lines changed
coffee_ws/src/coffee_head/.github/workflows Expand file tree Collapse file tree 2 files changed +54
-55
lines changed Original file line number Diff line number Diff line change 1- # coffee-budy
1+ # Coffee Buddy Robot
2+
3+ ## Overview
4+
5+ This repository contains the source code for the Coffee Buddy robot, a service robot designed to interact with humans in a coffee shop environment.
6+
7+ ## Repository Structure
8+
9+ - ` coffee_ws/ ` : ROS2 workspace
10+ - ` src/ ` : Source packages
11+ - ` coffee_head/ ` : Head control and tracking system
12+ - ` coffee_camera/ ` : Camera and perception system
13+ - Other packages...
14+
15+ ## Documentation
16+
17+ The project documentation is built using Sphinx with ReadTheDocs theme and is available at the project's GitHub Pages site.
18+
19+ ### Accessing Documentation
20+
21+ The documentation is automatically built and deployed to GitHub Pages when changes are pushed to the main branch.
22+
23+ ### Building Documentation Locally
24+
25+ To build the documentation locally:
26+
27+ 1 . Install the documentation dependencies:
28+ ``` bash
29+ pip install -r coffee_ws/src/coffee_head/docs/requirements.txt
30+ ```
31+
32+ 2 . Build the documentation:
33+ ``` bash
34+ cd coffee_ws/src/coffee_head/docs
35+ make html
36+ ```
37+
38+ 3 . Open ` coffee_ws/src/coffee_head/docs/build/html/index.html ` in your browser to view the documentation.
39+
40+ ## Installation
41+
42+ [ Installation instructions here]
43+
44+ ## Usage
45+
46+ [ Usage instructions here]
47+
48+ ## Contributing
49+
50+ [ Contribution guidelines here]
51+
52+ ## License
53+
54+ [ License information here]
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments