Skip to content

Commit

Permalink
chore: create README
Browse files Browse the repository at this point in the history
  • Loading branch information
insertish committed Oct 21, 2023
1 parent f4c84f9 commit ddca334
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# LASR Base

This repository contains all of LASR's ROS packages.

Packages are organised into the following folders:

- **common**: packages used throughout the project
- **helpers**: packages which provide Python / ROS helper functions / services
- **interfaces**: touch and web interfaces
- **navigation**: packages for augmenting / controlling navigation
- **speech**: speech recognition, conversation intent recognition, and text-to-speech
- **vision**: object recognition
- **documentation** (package): package containing scripts for generating READMEs and also the documentation site itself
- **legacy**: packages intended to be removed / rewritten and adapted into the new structure
- **skills**: commonly used states (for smach) which implement various actions
- **tasks**: implementations of robot demos / tasks / challenges

## Documentation

Currently to get the documentation up you should be in our container and then run:

```bash
catkin build documentation
source devel/setup.bash
rosrun documentation view.py
```

0 comments on commit ddca334

Please sign in to comment.