Skip to content

Commit ea0d71a

Browse files
committed
Add docs folder
1 parent 486ffe9 commit ea0d71a

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

docs/api.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# ArduinoGraphics Library
2+
3+
## Methods
4+
5+
### `begin()`
6+
7+
Description
8+
Initializes the graphics device.
9+
10+
#### Syntax
11+
12+
`YourScreen.begin()`
13+
14+
#### Parameters
15+
16+
None
17+
18+
#### Returns
19+
20+
1 for success, 0 on failure.
21+
22+
#### Example
23+
24+
```arduino
25+
if (!YourScreen.begin() {
26+
Serial.println(“Failed to initialize the display!”);
27+
while (1);
28+
}
29+
```
30+
31+
### `end()`
32+
33+
Description
34+
Stops the graphics device.
35+
36+
#### Syntax
37+
38+
`YourScreen.end()`
39+
40+
#### Parameters
41+
42+
None
43+
44+
#### Returns
45+
46+
Nothing
47+
48+
#### Example
49+
50+
```arduino
51+
YourScreen.end();
52+
```

docs/readme.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Arduino Graphics Library
2+
3+
This is a library that allows you to draw and write on screens with graphical primitives; it requires a specific hardware interfacce library to drive the screen you are using, therefore every screen type should have its own hardware specific library.
4+
5+
To use this library
6+
7+
```
8+
#include <ArduinoGraphics.h>
9+
```
10+
11+
To let you easily understand the usage of the graphics primitives, we are using a dummy screen object named YourScreen that should be substituted with the real one, Eg. MATRIX, OLED, TFT and so on. Refer to the hardware interfacing library of your screen to get more details.
12+
13+
The style and syntax of this library is inspired by [Processing 3](https://processing.org/) and we believe that learning Processing is very helpful to develop complex applications that combine the versatility of Arduino driven hardware with the power of a pc based graphical interface.

0 commit comments

Comments
 (0)