Import a simple README file (in Markdown format)

This commit is contained in:
Pierre Pronchery 2015-04-24 19:26:13 +02:00
parent 68ba8d5332
commit 0fe8aa2926
2 changed files with 41 additions and 1 deletions

40
README.md Normal file
View File

@ -0,0 +1,40 @@
DeforaOS VNCViewer
==================
About VNCViewer
---------------
This program is meant to be used as a client for the VNC remote desktop sharing
protocol.
This project is originally based on an example file from the gtk-vnc library.
Compiling Panel
---------------
The current requirements for compiling Panel are as follows:
* Gtk+ 2.4 or later, or Gtk+ 3.0 or later
* the gtk-vnc library
* an implementation of `make`
With these installed, the following command should be enough to compile
VNCViewer on most systems:
$ make
VNCViewer can then be installed as follows:
$ make install
On some systems, the Makefiles shipped can be re-generated accordingly thanks to
the DeforaOS configure tool.
The compilation process supports a number of options, such as PREFIX and DESTDIR
for packaging and portability, or OBJDIR for compilation outside of the source
tree.
Distributing Panel
------------------
DeforaOS Panel is subject to the terms of the LGPL license, version 2.0. Please
see the `COPYING` file for more information.

View File

@ -3,4 +3,4 @@ version=0.0.0
config=h
subdirs=src
dist=COPYING,Makefile,config.h
dist=COPYING,Makefile,README.md,config.h