You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,20 +30,20 @@ This system was used to to develop and validate the control system for [a large
30
30
31
31
## Documentation
32
32
33
+
> [!NOTE]
34
+
> Currently the technical documentation is only provided in Spanish. English translation is planned for future releases.
35
+
33
36
The following documentation is provided in this repository:
34
37
35
-
-**Technical Documentation**: [Sphinx](https://www.sphinx-doc.org) documentation sources in [/docs](docs/). You can build the HTML version of the documentation with the following commands:
38
+
-**Technical Documentation**: [Sphinx](https://www.sphinx-doc.org) documentation sources of the system documentation in [docs/](docs/). You can build the HTML version of the documentation with the following commands:
36
39
37
40
```bash
38
41
cd docs
39
42
uv venv && uv sync &&source .venv/bin/activate
40
43
make html
41
44
```
42
45
43
-
> [!NOTE]
44
-
> Currently the technical documentation is only provided in Spanish.
45
-
46
-
-**Electrical Schematics**: [KiCAD](https://www.kicad.org/) electrical schematics in [/schematics](schematics/).
46
+
-**Electrical Schematics**: [KiCAD](https://www.kicad.org/) electrical schematics in [schematics/](schematics/).
47
47
48
48
## Hardware Components
49
49
@@ -91,4 +91,4 @@ This work has been supported by project TED2021-130240B-I00 (IVRY) funded by MCI
0 commit comments