Skip to content

Add docs folder #20

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.

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 2 commits into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Add docs folder
  • Loading branch information
karlsoderby committed Jun 30, 2021
commit ea0d71a1c2b5549b92afb5c36d0924d5c451d0b6
52 changes: 52 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# ArduinoGraphics Library

## Methods

### `begin()`

Description
Initializes the graphics device.

#### Syntax

`YourScreen.begin()`

#### Parameters

None

#### Returns

1 for success, 0 on failure.

#### Example

```arduino
if (!YourScreen.begin() {
Serial.println(“Failed to initialize the display!”);
while (1);
}
```

### `end()`

Description
Stops the graphics device.

#### Syntax

`YourScreen.end()`

#### Parameters

None

#### Returns

Nothing

#### Example

```arduino
YourScreen.end();
```
13 changes: 13 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Arduino Graphics Library

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.

To use this library

```
#include <ArduinoGraphics.h>
```

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.

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.