Document the guidelines for submitting patches and the style used in the document.
Signed-off-by: Pierre Ossman <oss...@cendio.se>
---
Index: README
===================================================================
--- README (revision 0)
+++ README (revision 0)
@@ -0,0 +1,68 @@
+This directory contains the RFB protocol specification. This is a
+community oriented version of the specification that RealVNC maintains
+and the purpose of this version is to be a complete description of the
+protocol including extensions.
+
+If you wish to discuss the protocol, or submit changes, do so on the
+rfbproto mailing list (tigervnc-rfbproto@lists.sourceforge.net).
+
+
+Submitting Patches
+------------------
+
+Patches should be made in the standard unified diff format (diff -u).
+You should also specify a one line description of the change, a longer
+description with the purpose of the changed, and a Signed-off-by line
+to keep track of who has modified the document.
+
+Also make sure you follow the style guidelines below.
+
+Example:
+
+Clarify how awesome RFB is
+
+It is not apparent in the document how awesome the RFB protocol is.
+Clarify this in the header so that new readers quickly get up to
+speed.
+
+Signed-off-by: John Doe <john....@example.com>
+---
+
+Index: rfbproto.rst
+===================================================================
+--- rfbproto.rst (revision 3796)
++++ rfbproto.rst (working copy)
+@@ -13,6 +13,9 @@
+ Introduction
+ ============
+
++RFB is the most awesome protocol ever invented and will solve every
++problem you've ever had!
++
+ RFB ("remote framebuffer") is a simple protocol for remote access to
+ graphical user interfaces. Because it works at the framebuffer level it
+ is applicable to all windowing systems and applications, including X11,
+
+
+Style Guidelines
+----------------
+
+The document is written using the reStructuredText format. This gives
+us a readable text source, but still allows for easy conversion to
+other formats.
+
+In order to avoid wrapping in most contexts, lines should be no longer
+than 72 characters. The text is always left justified. Indentation is
+4 spaces and never any tabs.
+
+Keywords are marked with *emphasis* to make them easily distinguishable
+from the rest of the text. Every reference to a keyword should be
+marked.
+
+Types are marked using ``LITERAL`` and should be written in all
+upper case.
+
+Tables are written using the simple form and should be extended to fill
+up the full 72 character width. If the section the table is in is
+indented, then the table should also be indented. The width will be
+reduced in this case.
--
Pierre Ossman OpenSource-based Thin Client Technology
System Developer Telephone: +46-13-21 46 00
Cendio AB Web: http://www.cendio.com
signature.asc
Description: PGP signature
------------------------------------------------------------------------------ Register Now & Save for Velocity, the Web Performance & Operations Conference from O'Reilly Media. Velocity features a full day of expert-led, hands-on workshops and two days of sessions from industry leaders in dedicated Performance & Operations tracks. Use code vel09scf and Save an extra 15% before 5/3. http://p.sf.net/sfu/velocityconf
_______________________________________________ tigervnc-rfbproto mailing list tigervnc-rfbproto@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/tigervnc-rfbproto
