Skip to content

Readme edit #33

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

Merged
merged 4 commits into from
Jan 29, 2025
Merged

Readme edit #33

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6f87ef
Update README.md
edwin-giang Jan 29, 2025
e807f1e
Update README.md
edwin-giang Jan 29, 2025
b9428fb
back to top
edwin-giang Jan 29, 2025
4ce94fa
title change
edwin-giang Jan 29, 2025
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
21 changes: 8 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,28 @@
# OpenArm
A fully open-source robot arm project

# Overview
This repository outlines all the necessary materials and software repositories required in order to build, setup, and deploy OpenArm. These are outlined in the [Hardware](#ssHardware) and [Software](#ssSoftware) sections. In addition this, this repository also provides sample code to assist with robot simulation setup in Genesis and Gazebo environments. Finally, there is example code for tele-operation with bilateral feedback implementation. Directions the setup for these features are detailed in the [Simulation](#ssSimulation) and [Teleoperation](#ssTeleoperation) sections.
# OpenArm: A fully open-source robot arm project
This repository outlines all the necessary materials and software repositories required in order to build, setup, and deploy OpenArm. These are outlined in the [Hardware](#Hardware) and [Software](#Software) sections. In addition this, this repository also provides sample code to assist with robot simulation setup in Genesis and Gazebo environments. Finally, there is example code for tele-operation with bilateral feedback implementation. Directions the setup for these features are detailed in the [Simulation](#Simulation) and [Teleoperation](#Teleoperation) sections.

For more background about the project details, features, and other information, please refer to the following links:
- Website: https://www.notion.so/reazon-research/OpenArm-113446ca7f73805fa06cd8d24315122b
- X:
- [Other Resources](#ssResources)

in [Section `Features`](#feature)

## Hardware <a id= 'ssHardware'></a>
## Hardware
- Provide CAD overview
- Purchasing List/BOM
- Assembly Guide

## Software <a id= 'ssSoftware'></a>
## Software
- Arm Control

## Simulation <a id= 'ssSimulation'></a>
## Simulation
- ROS2 Examples
- Genesis Examples

## Teleoperation <a id= 'ssTeleoperation'></a>
## Teleoperation
- Tracker Examples?
- Bilateral Feedback Examples?

## Other Resources <a id= 'ssResources'></a>
## Other Resources
- Risk Assessment Guideline

## Feature
<a href="#top">Back to top</a>