Skip to content

Commit

Permalink
add README.md
Browse files Browse the repository at this point in the history
add library.properties
add library.json
rename docs
  • Loading branch information
Links2004 committed Jan 7, 2016
1 parent 093b5e9 commit 0da3608
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Compiled Object files
*.slo
*.lo
*.o
*.obj

# Precompiled Headers
*.gch
*.pch

# Compiled Dynamic libraries
*.so
*.dylib
*.dll

# Fortran module files
*.mod

# Compiled Static libraries
*.lai
*.la
*.a
*.lib

# Executables
*.exe
*.out
*.app

40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
VNC Client for Arduino
===========================================

a VNC Client for Arduino based on rfbproto.

##### Supported features #####
- Bell
- CutText (clipboard)

##### Supported encodings #####
- RAW
- RRE
- CORRE
- HEXTILE
- COPYRECT (if display support it)

##### Not supported encodings #####
- TIGHT
- ZLIB

##### Supported Hardware #####
- ESP8266 [Arduino for ESP8266](https://github.com/Links2004/Arduino)

may run on Arduino DUE too.

##### Supported Displays #####
- ILI9341

more possible using ```VNCdisplay``` Interface

### Issues ###
Submit issues to: https://github.com/Links2004/arduinoVNC/issues

### License and credits ###

The library is licensed under [LGPLv2.1](https://github.com/Links2004/arduinoVNC/blob/master/LICENSE)


D3DES by Richard Outerbridge (public domain)

File renamed without changes.
File renamed without changes.
19 changes: 19 additions & 0 deletions library.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "arduinoVNC",
"keywords": "VNC, rfbproto, client, image, rfb",
"description": "VNC Client for Arduino",
"repository":
{
"type": "git",
"url": "https://github.com/Links2004/arduinoVNC.git"
},
"exclude": "tests",
"frameworks": "arduino",
"platforms": "esp8266",
"authors":
{
"name": "Markus Sattler",
"url": "https://github.com/Links2004",
"maintainer": true
}
}
9 changes: 9 additions & 0 deletions library.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name=arduinoVNC
version=1.0
author=Markus Sattler
maintainer=Markus Sattler
sentence=VNC Client for Arduino
paragraph=
category=Display
url=https://github.com/Links2004/arduinoVNC
architectures=esp8266

0 comments on commit 0da3608

Please sign in to comment.