Skip to content

Commit 42e96b0

Browse files
committed
docs: Branding Consistency
Updated to follow product naming conventions and logo design guidelines. Changes include: - Updated logos images - Updated product naming to eteeController and eteeDongle - Fixed relative link
1 parent f6ba66c commit 42e96b0

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
![Logo Light](./img/logo-banner-light-mode.png#gh-light-mode-only)
1414

1515
<p align="center">
16-
Official Python API for the eteeController devices.
16+
Official Python API for the eteeControllers.
1717
<br />
1818
<a href="https://tg0-etee-python-api.readthedocs-hosted.com/en/latest/index.html#"><strong>Explore the docs »</strong></a>
1919
<br />
@@ -96,21 +96,21 @@ In this repository, you can access:
9696
- etee Python API example scripts
9797
- Setup files
9898

99-
With this API, you will be able to retrieve a wide range of [data from the controllers][url-documentation-data]:
99+
With this API, you will be able to retrieve a wide range of [data from the eteeControllers][url-documentation-data]:
100100
* **Tactile data**: individual finger curling and pressure, trackpad, slider LED, tracker (connection, proximity sensor; no positional tracking) and system button.
101101

102102
<p align="center">
103103
<img width="700" src="./img/etee-controller-sensors.jpg">
104104
<br/>
105-
<em>Tactile and sensing data from the controller.</em>
105+
<em>Tactile and sensing data from the eteeController.</em>
106106
</p>
107107

108108
* **Gestures**: grip, pinch and point gestures.
109109

110110
<p align="center">
111111
<img width="700" src="./img/etee-gestures.jpg">
112112
<br/>
113-
<em>Main etee gestures.</em>
113+
<em>Main eteeController gestures.</em>
114114
</p>
115115

116116
* **Inertial Measuring Units (IMU) and 3D rotation**: raw 9-axis IMU data (accelerometer, gyroscope, magnetometer data) and 3D rotation estimations (quaternion, euler angles).
@@ -199,8 +199,8 @@ your Python environment, by using the `setup.py` script.
199199

200200
### Hardware Setup
201201

202-
To get started, [set up the hardware][url-documentation-setup-hw]. This involves connecting the device dongle to your
203-
PC or laptop, and turning ON the controllers. You will know they are connected if the device dongle keeps blinking in
202+
To get started, [set up the hardware][url-documentation-setup-hw]. This involves connecting the eteeDongle to your
203+
PC or laptop, and turning ON the eteeControllers. You will know they are connected if the eteeDongle keeps blinking in
204204
the following pattern: pink-pink-blue.
205205

206206
### Example Scripts
@@ -220,7 +220,7 @@ We also have [quickstart][url-documentation-quickstart] and [more detailed devel
220220
in our documentation page. This might help you understand the different API functionalities and how to integrate them
221221
in your custom applications.
222222

223-
_To learn more about the API and the controller data, visit our [Developer Documentation Site][url-documentation]_
223+
_To learn more about the API and the eteeController data, visit our [Developer Documentation Site][url-documentation]_
224224

225225
<a href="https://tg0-etee-python-api.readthedocs-hosted.com/en/latest/index.html#">
226226
<img src="https://img.shields.io/badge/docs-etee Python API-lightgrey"
@@ -305,7 +305,7 @@ Code and documentation authors include:
305305

306306
For any queries or reports about the API, please use the [**Issues tab**][url-issues-tab] in this repository.
307307
When possible, use an identifier to help us describe your query, report or request.
308-
See more at: <a href="###semantic-type-prefixes">Semantic Type Prefixes</a>
308+
See more at: <a href="#semantic-type-prefixes">Semantic Type Prefixes</a>.
309309

310310
For further support or queries, you can contact us:
311311
- Support e-mail: [customer@eteexr.com](customer@eteexr.com)

img/logo-banner-dark-mode.png

7.92 KB
Loading

img/logo-banner-light-mode.png

12.6 KB
Loading

img/logo-dark-mode.png

19.9 KB
Loading

img/logo-light-mode.png

18.2 KB
Loading

0 commit comments

Comments
 (0)