Formatting cleanup of README
This commit is contained in:
Samuel Mannehed
parent
4cb91c4269
commit
b55bfcf04b
84
README.md
84
README.md
|
|
@ -12,34 +12,34 @@ Many companies, projects and products have integrated noVNC including
|
|||
[OpenStack](http://www.openstack.org),
|
||||
[OpenNebula](http://opennebula.org/),
|
||||
[LibVNCServer](http://libvncserver.sourceforge.net), and
|
||||
[ThinLinc](https://cendio.com/thinlinc).
|
||||
See [the Projects and Companies wiki page](https://github.com/kanaka/noVNC/wiki/Projects-and-companies-using-noVNC)
|
||||
[ThinLinc](https://cendio.com/thinlinc). See
|
||||
[the Projects and Companies wiki page](https://github.com/kanaka/noVNC/wiki/Projects-and-companies-using-noVNC)
|
||||
for a more complete list with additional info and links.
|
||||
|
||||
### News/help/contact
|
||||
|
||||
Notable commits, announcements and news are posted to
|
||||
<a href="http://www.twitter.com/noVNC">@noVNC</a>
|
||||
<a href="http://www.twitter.com/noVNC">@noVNC</a>.
|
||||
|
||||
If you are a noVNC developer/integrator/user (or want to be) please
|
||||
join the <a
|
||||
href="https://groups.google.com/forum/?fromgroups#!forum/novnc">noVNC
|
||||
discussion group</a>
|
||||
If you are a noVNC developer/integrator/user (or want to be) please join the
|
||||
<a href="https://groups.google.com/forum/?fromgroups#!forum/novnc">
|
||||
noVNC discussion group</a>.
|
||||
|
||||
Bugs and feature requests can be submitted via [github
|
||||
issues](https://github.com/kanaka/noVNC/issues). If you are looking
|
||||
for a place to start contributing to noVNC, a good place to start
|
||||
would be the issues that are marked as
|
||||
Bugs and feature requests can be submitted via
|
||||
[github issues](https://github.com/kanaka/noVNC/issues).
|
||||
If you are looking for a place to start contributing to noVNC, a good place to
|
||||
start would be the issues that are marked as
|
||||
["patchwelcome"](https://github.com/kanaka/noVNC/issues?labels=patchwelcome).
|
||||
|
||||
If you want to show appreciation for noVNC you could donate to a great
|
||||
non-profits such as: [Compassion
|
||||
International](http://www.compassion.com/), [SIL](http://www.sil.org),
|
||||
[Habitat for Humanity](http://www.habitat.org), [Electronic Frontier
|
||||
Foundation](https://www.eff.org/), [Against Malaria
|
||||
Foundation](http://www.againstmalaria.com/), [Nothing But
|
||||
Nets](http://www.nothingbutnets.net/), etc. Please tweet <a
|
||||
href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
|
||||
If you want to show appreciation for noVNC you could donate to a great non-
|
||||
profits such as:
|
||||
[Compassion International](http://www.compassion.com/),
|
||||
[SIL](http://www.sil.org),
|
||||
[Habitat for Humanity](http://www.habitat.org),
|
||||
[Electronic Frontier Foundation](https://www.eff.org/),
|
||||
[Against Malaria Foundation](http://www.againstmalaria.com/),
|
||||
[Nothing But Nets](http://www.nothingbutnets.net/), etc.
|
||||
Please tweet <a href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
|
||||
|
||||
|
||||
### Features
|
||||
|
|
@ -59,9 +59,11 @@ href="http://www.twitter.com/noVNC">@noVNC</a> if you do.
|
|||
|
||||
Running in Chrome before and after connecting:
|
||||
|
||||
<img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400> <img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400>
|
||||
<img src="http://kanaka.github.com/noVNC/img/noVNC-5.png" width=400>
|
||||
<img src="http://kanaka.github.com/noVNC/img/noVNC-7.jpg" width=400>
|
||||
|
||||
See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
|
||||
See more screenshots
|
||||
<a href="http://kanaka.github.com/noVNC/screenshots.html">here</a>.
|
||||
|
||||
|
||||
### Browser Requirements
|
||||
|
|
@ -70,45 +72,49 @@ See more screenshots <a href="http://kanaka.github.com/noVNC/screenshots.html">h
|
|||
|
||||
* HTML5 Canvas, WebSockets and Typed Arrays
|
||||
|
||||
* Fast Javascript Engine: this is not strictly a requirement, but
|
||||
without a fast Javascript engine, noVNC might be painfully slow.
|
||||
* Fast Javascript Engine: this is not strictly a requirement, but without a
|
||||
fast Javascript engine, noVNC might be painfully slow.
|
||||
|
||||
* See the more detailed [browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support).
|
||||
* See the more detailed
|
||||
[browser compatibility wiki page](https://github.com/kanaka/noVNC/wiki/Browser-support).
|
||||
|
||||
|
||||
### Server Requirements
|
||||
|
||||
Unless you are using a VNC server with support for WebSockets
|
||||
connections (such as
|
||||
[x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
|
||||
Unless you are using a VNC server with support for WebSockets connections (such
|
||||
as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
|
||||
[QEMU](http://www.qemu.org/), or
|
||||
[PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to
|
||||
use a WebSockets to TCP socket proxy. There is a python proxy included
|
||||
[PocketVNC](http://www.pocketvnc.com/blog/?page_id=866)), you need to use a
|
||||
WebSockets to TCP socket proxy. There is a python proxy included
|
||||
('websockify').
|
||||
|
||||
|
||||
### Quick Start
|
||||
|
||||
* Use the launch script to start a mini-webserver and the WebSockets
|
||||
proxy (websockify). The `--vnc` option is used to specify the location of
|
||||
a running VNC server:
|
||||
* Use the launch script to start a mini-webserver and the WebSockets proxy
|
||||
(websockify). The `--vnc` option is used to specify the location of a running
|
||||
VNC server:
|
||||
|
||||
`./utils/launch.sh --vnc localhost:5901`
|
||||
|
||||
* Point your browser to the cut-and-paste URL that is output by the
|
||||
launch script. Enter a password if the VNC server has one
|
||||
configured. Hit the Connect button and enjoy!
|
||||
* Point your browser to the cut-and-paste URL that is output by the launch
|
||||
script. Enter a password if the VNC server has one configured. Hit the
|
||||
Connect button and enjoy!
|
||||
|
||||
|
||||
### Other Pages
|
||||
|
||||
* [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections). How to setup websockify so that you can use encrypted connections from noVNC.
|
||||
* [Encrypted Connections](https://github.com/kanaka/websockify/wiki/Encrypted-Connections)
|
||||
- How to setup websockify so that you can use encrypted connections from noVNC.
|
||||
|
||||
* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage). Starting a VNC server, advanced websockify usage, etc.
|
||||
* [Advanced Usage](https://github.com/kanaka/noVNC/wiki/Advanced-usage)
|
||||
- Starting a VNC server, advanced websockify usage, etc.
|
||||
|
||||
* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into existing projects.
|
||||
* [Integrating noVNC](https://github.com/kanaka/noVNC/wiki/Integration) into
|
||||
existing projects.
|
||||
|
||||
* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting) problems.
|
||||
* [Troubleshooting noVNC](https://github.com/kanaka/noVNC/wiki/Troubleshooting)
|
||||
problems.
|
||||
|
||||
|
||||
### Authors/Contributors
|
||||
|
|
|
|||
Loading…
Reference in New Issue