Skip to content

Commit 0da3608

Browse files
committed
add README.md
add library.properties add library.json rename docs
1 parent 093b5e9 commit 0da3608

File tree

6 files changed

+97
-0
lines changed

6 files changed

+97
-0
lines changed

.gitignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Compiled Object files
2+
*.slo
3+
*.lo
4+
*.o
5+
*.obj
6+
7+
# Precompiled Headers
8+
*.gch
9+
*.pch
10+
11+
# Compiled Dynamic libraries
12+
*.so
13+
*.dylib
14+
*.dll
15+
16+
# Fortran module files
17+
*.mod
18+
19+
# Compiled Static libraries
20+
*.lai
21+
*.la
22+
*.a
23+
*.lib
24+
25+
# Executables
26+
*.exe
27+
*.out
28+
*.app
29+

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
VNC Client for Arduino
2+
===========================================
3+
4+
a VNC Client for Arduino based on rfbproto.
5+
6+
##### Supported features #####
7+
- Bell
8+
- CutText (clipboard)
9+
10+
##### Supported encodings #####
11+
- RAW
12+
- RRE
13+
- CORRE
14+
- HEXTILE
15+
- COPYRECT (if display support it)
16+
17+
##### Not supported encodings #####
18+
- TIGHT
19+
- ZLIB
20+
21+
##### Supported Hardware #####
22+
- ESP8266 [Arduino for ESP8266](https://github.com/Links2004/Arduino)
23+
24+
may run on Arduino DUE too.
25+
26+
##### Supported Displays #####
27+
- ILI9341
28+
29+
more possible using ```VNCdisplay``` Interface
30+
31+
### Issues ###
32+
Submit issues to: https://github.com/Links2004/arduinoVNC/issues
33+
34+
### License and credits ###
35+
36+
The library is licensed under [LGPLv2.1](https://github.com/Links2004/arduinoVNC/blob/master/LICENSE)
37+
38+
39+
D3DES by Richard Outerbridge (public domain)
40+
File renamed without changes.
File renamed without changes.

library.json

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "arduinoVNC",
3+
"keywords": "VNC, rfbproto, client, image, rfb",
4+
"description": "VNC Client for Arduino",
5+
"repository":
6+
{
7+
"type": "git",
8+
"url": "https://github.com/Links2004/arduinoVNC.git"
9+
},
10+
"exclude": "tests",
11+
"frameworks": "arduino",
12+
"platforms": "esp8266",
13+
"authors":
14+
{
15+
"name": "Markus Sattler",
16+
"url": "https://github.com/Links2004",
17+
"maintainer": true
18+
}
19+
}

library.properties

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=arduinoVNC
2+
version=1.0
3+
author=Markus Sattler
4+
maintainer=Markus Sattler
5+
sentence=VNC Client for Arduino
6+
paragraph=
7+
category=Display
8+
url=https://github.com/Links2004/arduinoVNC
9+
architectures=esp8266

0 commit comments

Comments
 (0)