Skip to content

Commit 1b0660f

Browse files
authored
Minor changes in README.md
1 parent e060e16 commit 1b0660f

1 file changed

Lines changed: 16 additions & 17 deletions

File tree

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# LinuxCNC Motor Control Testbed
22

3-
<div align="center">
3+
A motor control testbed using the open-source [LinuxCNC](https://www.linuxcnc.org) platform integrated with the [Mesa Electronics](https://store.mesanet.com/) 7i96S and 7I77 interface cards and the [igus® dryve D1](https://www.igus.eu/product/D1) motor controllers.
44

5-
<img src="media/testbed_picture.jpg" style="width:100%; max-width:700px;"/>
5+
This system was used to to develop and validate the control system for [a large high-precision 3-axis gantry robot system](https://github.com/GTEC-UDC/linuxcnc_gantry_robot).
66

7+
<div align="center">
8+
79
[![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-limegreen.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
810
[![Documentation](https://img.shields.io/badge/docs-sphinx-blue.svg)](docs/)
911

1012
</div>
1113

14+
<div align="center">
15+
<img src="media/testbed_picture.jpg" width="700"/>
16+
</div>
17+
1218
<!-- Video uploaded via drag-and-drop to the GitHub editor -->
1319
<!-- Note: GitHub does not render video files from the repository. See: https://github.com/orgs/community/discussions/19403 -->
1420
<!-- The video is also stored at media/testbed_video.webm within the repo -->
15-
<video src="https://github.com/user-attachments/assets/f6507526-396f-41c5-9737-cb749e45726b"><video/>
16-
17-
## Overview
18-
19-
A motor control testbed using the open-source [LinuxCNC](https://www.linuxcnc.org) platform integrated with the [Mesa Electronics](https://store.mesanet.com/) 7i96S and 7I77 interface cards and the [igus® dryve D1](https://www.igus.eu/product/D1) motor controllers.
20-
21-
This system was used to to develop and validate the control system for a gantry robot.
21+
<video type="video/webm" src="https://github.com/user-attachments/assets/f6507526-396f-41c5-9737-cb749e45726b"><video/>
2222

2323
## Key Features
2424

@@ -32,16 +32,15 @@ This system was used to to develop and validate the control system for a gantry
3232

3333
The following documentation is provided in this repository:
3434

35-
- **Technical Documentation**: Complete system documentation and setup guide in `docs/`
36-
- **Electrical Installation**: KiCAD electrical schematics in `electrical_installation/`
35+
- **Technical Documentation**: [Sphinx](https://www.sphinx-doc.org) documentation sources in [/docs](docs/). To build the documentation execute the following commands:
3736

38-
To build the Sphinx documentation:
37+
```bash
38+
cd docs
39+
pip install -r requirements.txt
40+
make html
41+
```
3942

40-
```bash
41-
cd docs
42-
pip install -r requirements.txt
43-
make html
44-
```
43+
- **Electrical Schematics**: [KiCAD](https://www.kicad.org/) electrical schematics in [/schematics](schematics/).
4544

4645
## Hardware Components
4746

0 commit comments

Comments
 (0)