[gmime: 7/10] Updated README to use markdown

From: Jeffrey Stedfast <fejj src gnome org>
To: commits-list gnome org
Cc:
Subject: [gmime: 7/10] Updated README to use markdown
Date: Fri, 17 Feb 2017 20:04:45 +0000 (UTC)
commit b5cbc68a67956643862d894f0e9c95a0eb803f3b
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Wed Feb 15 19:25:56 2017 -0500

    Updated README to use markdown

 README  |  179 +++++++++++++++++----------------------------------------------
 RFCs.md |   60 +++++++++++++++++++++
 2 files changed, 108 insertions(+), 131 deletions(-)
---
diff --git a/README b/README
index eb73962..b080407 100644
--- a/README
+++ b/README
@@ -1,101 +1,11 @@
-                            GMime, version 2.6.23
-                   by Jeffrey Stedfast <fejj gnome org>
-
-
-WHAT IS GMIME
--------------
-
-GMime is a C/C++ library for parsing and creating messages using
-the Multipurpose Internet Mail Extension (MIME) as defined by the
-following RFCs:
-
- * 0822: Standard for the Format of Arpa Internet Text Messages
- * 1341: MIME (Multipurpose Internet Mail Extensions): Mechanisms for
-         Specifying and Describing the Format of Internet Message Bodies
- * 1342: Representation of Non-ASCII Text in Internet Message Headers
- * 1521: MIME (Multipurpose Internet Mail Extensions) Part One:
-         Mechanisms for Specifying and Describing the Format of 
-         Internet Message Bodies (Obsoletes rfc1341)
- * 1522: MIME (Multipurpose Internet Mail Extensions) Part Two: Message
-         Header Extensions for Non-ASCII Text (Obsoletes rfc1342)
- * 1544: The Content-MD5 Header Field
- * 1847: Security Multiparts for MIME: Multipart/Signed and 
-         Multipart/Encrypted
- * 1864: The Content-MD5 Header Field (Obsoletes rfc1544)
- * 2015: MIME Security with Pretty Good Privacy (PGP)
- * 2045: Multipurpose Internet Mail Extensions (MIME) Part One:
-         Format of Internet Message Bodies
- * 2046: Multipurpose Internet Mail Extensions (MIME) Part Two:
-         Media Types
- * 2047: Multipurpose Internet Mail Extensions (MIME) Part Three:
-         Message Header Extensions for Non-ASCII Text
- * 2048: Multipurpose Internet Mail Extensions (MIME) Part Four:
-         Registration Procedures
- * 2049: Multipurpose Internet Mail Extensions (MIME) Part Five:
-         Conformance Criteria and Examples
- * 2183: Communicating Presentation Information in Internet Messages:
-         The Content-Disposition Header Field
- * 2184: MIME Parameter Value and Encoded Word Extensions: Character
-         Sets, Languages, and Continuations
- * 2231: MIME Parameter Value and Encoded Word Extensions: Character
-         Sets, Languages, and Continuations (Obsoletes rfc2184)
- * 2311: S/MIME Version 2 Message Specification
- * 2312: S/MIME Version 2 Certificate Handling
- * 2315: PKCS #7: Cryptographic Message Syntax
- * 2630: Cryptographic Message Syntax
- * 2632: S/MIME Version 3 Certificate Handling (Obsoletes rfc2311)
- * 2633: S/MIME Version 3 Message Specification (Obsoletes rfc2312)
- * 2634: Enhanced Security Services for S/MIME
- * 2822: Internet Message Format (Obsoletes rfc822)
- * 3156: MIME Security with OpenPGP (Updates rfc2015)
- * 3850: S/MIME Version 3.1 Certificate Handling (Obsoletes rfc2632)
- * 3851: S/MIME Version 3.1 Message Specification (Obsoletes rfc2633)
- * 5322: Internet Message Format (Obsoletes rfc2822)
- * 5750: S/MIME Version 3.2 Certificate Handling (Obsoletes rfc3850)
- * 5751: S/MIME Version 3.2 Message Specification (Obsoletes rfc3851)
-
-Other RFCs of interest:
-
- * 1872: The MIME Multipart/Related Content-type
- * 1927: Suggested Additional MIME Types for Associating Documents
- * 2110: MIME E-mail Encapsulation of Aggregate Documents, such as HTML (MHTML)
- * 2111: Content-ID and Message-ID Uniform Resource Locators
- * 2387: The Multipart/Related Content-Type.
- * 2388: Returning Values from Forms: multipart/form-data
- * 2424: Content Duration MIME Header Definition
- * 3280: Internet X.509 Public Key Infrastructure certificate and 
-         Certificate Revocation List (CRL) Profile
-
-Cryptography related RFCs:
-
- * 2268: A Description of the RC2(r) Encryption Algorithm
- * 2313: PKCS #1: RSA Encryption
- * 2314: PKCS #10: Certification Request Syntax
- * 2631: Diffie-Hellman Key Agreement Method
-
-
-LICENSE INFORMATION
--------------------
-
-The GMime library is Copyright (C) 2000-2014 Jeffrey Stedfast.
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-
-
-HISTORY
--------
+# GMime
+
+## What is GMime?
+
+GMime is a C/C++ library which may be used for the creation and parsing of messages using the Multipurpose
+Internet Mail Extension (MIME) as defined by [numerous IETF 
specifications](https://github.com/jstedfast/gmime/blob/master/RFCs.md).
+
+## History
 
 As a developer and user of Electronic Mail clients, I had come to
 realize that the vast majority of E-Mail client (and server) software
@@ -107,31 +17,46 @@ this issue by following the MIME specification as closely as possible
 while also providing programmers with an extremely easy to use
 high-level application programming interface (API).
 
+## License Information
 
-OBTAINING GMIME
----------------
+The GMime library is Copyright (C) 2000-2017 Jeffrey Stedfast and is licensed under the LGPL v2.1
 
-Sources to GMime may be obtained from:
-  http://download.gnome.org/pub/GNOME/sources/gmime/
-or
-  ftp://ftp.gnome.org/pub/GNOME/sources/gmime/
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
 
-Information regarding GMime may be obtained from the Spruce home page:
-  http://spruce.sourceforge.net/gmime/
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
-Experimental versions of GMime may be obtained by following the
-directions at http://developer.gnome.org/tools/svn.html
 
-  git clone git://git.gnome.org/gmime
+## Getting the Source Code
 
+You can download either official public release tarballs of GMime at
+[http://download.gnome.org/pub/GNOME/sources/gmime/](http://download.gnome.org/pub/GNOME/sources/gmime/)
+or
+[ftp://ftp.gnome.org/pub/GNOME/sources/gmime/](ftp://ftp.gnome.org/pub/GNOME/sources/gmime/).
 
-REQUIREMENTS
-------------
+If you would like to contribute to the GMime project, it is recommended that you grab the
+source code from the official GitHub repository at
+[http://github.com/jstedfast/gmime](https://github.com/jstedfast/gmime). Cloning this repository
+can be done using the following command:
+
+    git clone https://github.com/jstedfast/gmime.git
+
+
+## Requirements
 
 For proper compilation and functionality of GMime, the following packages
 are REQUIRED:
 
-  - Glib version >= 2.18.0
+  - Glib version >= 2.32.0
 
     Glib provides a number of portability-enhancing functions and types.
     Glib is included in most GMime-supported operating system
@@ -139,10 +64,9 @@ are REQUIRED:
       ftp://ftp.gtk.org/pub/glib
 
 
-DOCUMENTATION
--------------
+## Documentation
 
-This is the README file for GMime.  Additional documentation related to
+This is the README file for GMime. Additional documentation related to
 development using GMime has been included within the source release
 of GMime.
 
@@ -172,21 +96,18 @@ You can find online developer documentation at
 http://library.gnome.org/devel/gmime/stable/
 
 
-MAILING-LIST
-------------
+# Mailing Lists
 
 For discussion of GMime development (either of GMime itself or using
 GMime in your own application), you may find the GMime-Devel
 mailing-list helpful. To subscribe, please see
-http://mail.gnome.org/mailman/listinfo/gmime-devel-list
+[http://mail.gnome.org/mailman/listinfo/gmime-devel-list](http://mail.gnome.org/mailman/listinfo/gmime-devel-list)
 
 
-BINDINGS
---------
+# Bindings
 
-Other developers have been working to make GMime available to
-programmers in other languages. The current list of known bindings
-are:
+Other developers have been working to make GMime available to programmers in other languages.
+The current list of known bindings are:
 
 - Go: https://github.com/sendgrid/go-gmime
 
@@ -195,15 +116,11 @@ are:
 - .NET (Mono): Included in this distribution (Obsolete).
 
 
-Note: It is recommended that MimeKit[1] be used in place of GMime-Sharp in
+Note: It is recommended that [MimeKit](https://github.com/jstedfast/MimeKit) be used in place of GMime-Sharp 
in
 .NET 4.0 (or later) environments.
 
 
-1. MimeKit: https://github.com/jstedfast/MimeKit
-
-
-REPORTING BUGS
---------------
+# Reporting Bugs
 
-Bugs may be reported to the GMime development team by submitting a bug
-report for the gmime module at http://bugzilla.gnome.org/
+Bugs may be reported to the GMime development team by creating a new
+[issue](https://github.com/jstedfast/gmime/issues).
diff --git a/RFCs.md b/RFCs.md
new file mode 100644
index 0000000..b079ff0
--- /dev/null
+++ b/RFCs.md
@@ -0,0 +1,60 @@
+### Specifications
+
+GMime implements the following IETF specifications defining Internet Mail and MIME:
+
+* [0822](http://www.ietf.org/rfc/rfc0822.txt): Standard for the Format of Arpa Internet Text Messages
+* [1341](http://www.ietf.org/rfc/rfc1341.txt): MIME (Multipurpose Internet Mail Extensions): Mechanisms for 
Specifying and Describing the Format of Internet Message Bodies
+* [1342](http://www.ietf.org/rfc/rfc1342.txt): Representation of Non-ASCII Text in Internet Message Headers
+* [1521](http://www.ietf.org/rfc/rfc1521.txt): MIME (Multipurpose Internet Mail Extensions) Part One: 
Mechanisms for Specifying and Describing the Format of Internet Message Bodies (Obsoletes rfc1341)
+* [1522](http://www.ietf.org/rfc/rfc1522.txt): MIME (Multipurpose Internet Mail Extensions) Part Two: 
Message Header Extensions for Non-ASCII Text (Obsoletes rfc1342)
+* [1544](http://www.ietf.org/rfc/rfc1544.txt): The Content-MD5 Header Field
+* [1847](http://www.ietf.org/rfc/rfc1847.txt): Security Multiparts for MIME: Multipart/Signed and 
Multipart/Encrypted
+* [1864](http://www.ietf.org/rfc/rfc1864.txt): The Content-MD5 Header Field (Obsoletes rfc1544)
+* [2015](http://www.ietf.org/rfc/rfc2015.txt): MIME Security with Pretty Good Privacy (PGP)
+* [2045](http://www.ietf.org/rfc/rfc2045.txt): Multipurpose Internet Mail Extensions (MIME) Part One: Format 
of Internet Message Bodies
+* [2046](http://www.ietf.org/rfc/rfc2046.txt): Multipurpose Internet Mail Extensions (MIME) Part Two: Media 
Types
+* [2047](http://www.ietf.org/rfc/rfc2047.txt): Multipurpose Internet Mail Extensions (MIME) Part Three: 
Message Header Extensions for Non-ASCII Text
+* [2048](http://www.ietf.org/rfc/rfc2048.txt): Multipurpose Internet Mail Extensions (MIME) Part Four: 
Registration Procedures
+* [2049](http://www.ietf.org/rfc/rfc2049.txt): Multipurpose Internet Mail Extensions (MIME) Part Five: 
Conformance Criteria and Examples
+* [2110](http://www.ietf.org/rfc/rfc2110.txt): MIME E-mail Encapsulation of Aggregate Documents, such as 
HTML (MHTML)
+* [2183](http://www.ietf.org/rfc/rfc2183.txt): Communicating Presentation Information in Internet Messages: 
The Content-Disposition Header Field
+* [2184](http://www.ietf.org/rfc/rfc2184.txt): MIME Parameter Value and Encoded Word Extensions: Character 
Sets, Languages, and Continuations
+* [2231](http://www.ietf.org/rfc/rfc2231.txt): MIME Parameter Value and Encoded Word Extensions: Character 
Sets, Languages, and Continuations (Obsoletes rfc2184)
+* [2311](http://www.ietf.org/rfc/rfc2311.txt): S/MIME Version 2 Message Specification
+* [2312](http://www.ietf.org/rfc/rfc2312.txt): S/MIME Version 2 Certificate Handling
+* [2315](http://www.ietf.org/rfc/rfc2315.txt): PKCS #7: Cryptographic Message Syntax
+* [2557](http://www.ietf.org/rfc/rfc2557.txt): MIME Encapsulation of Aggregate Documents, such as HTML 
(MHTML) (Obsoletes rfc2110)
+* [2630](http://www.ietf.org/rfc/rfc2630.txt): Cryptographic Message Syntax
+* [2632](http://www.ietf.org/rfc/rfc2632.txt): S/MIME Version 3 Certificate Handling
+* [2633](http://www.ietf.org/rfc/rfc2633.txt): S/MIME Version 3 Message Specification
+* [2634](http://www.ietf.org/rfc/rfc2634.txt): Enhanced Security Services for S/MIME
+* [2822](http://www.ietf.org/rfc/rfc2822.txt): Internet Message Format (Obsoletes rfc0822)
+* [3156](http://www.ietf.org/rfc/rfc3156.txt): MIME Security with OpenPGP (Updates rfc2015)
+* [3850](http://www.ietf.org/rfc/rfc3850.txt): S/MIME Version 3.1 Certificate Handling (Obsoletes rfc2632)
+* [3851](http://www.ietf.org/rfc/rfc3851.txt): S/MIME Version 3.1 Message Specification (Obsoletes rfc2633)
+* [4262](http://www.ietf.org/rfc/rfc4262.txt): X.509 Certificate Extension for S/MIME Capabilities
+* [5322](http://www.ietf.org/rfc/rfc5322.txt): Internet Message Format (Obsoletes rfc2822)
+* [5750](http://www.ietf.org/rfc/rfc5750.txt): S/MIME Version 3.2 Certificate Handling (Obsoletes rfc3850)
+* [5751](http://www.ietf.org/rfc/rfc5751.txt): S/MIME Version 3.2 Message Specification (Obsoletes rfc3851)
+
+#### Other RFCs of interest:
+
+* [1523](http://www.ietf.org/rfc/rfc1523.txt): The text/enriched MIME Content-type
+* [1872](http://www.ietf.org/rfc/rfc1872.txt): The MIME Multipart/Related Content-type
+* [1892](http://www.ietf.org/rfc/rfc1892.txt): The Multipart/Report Content Type for the Reporting of  Mail 
System Administrative Messages
+* [1927](http://www.ietf.org/rfc/rfc1927.txt): Suggested Additional MIME Types for Associating Documents
+* [2111](http://www.ietf.org/rfc/rfc2111.txt): Content-ID and Message-ID Uniform Resource Locators
+* [2112](http://www.ietf.org/rfc/rfc2112.txt): The MIME Multipart/Related Content-type (Obsoletes rfc1872)
+* [2298](http://www.ietf.org/rfc/rfc2298.txt): An Extensible Message Format for Message Disposition 
Notifications
+* [2387](http://www.ietf.org/rfc/rfc2387.txt): The MIME Multipart/Related Content-type (Obsoletes rfc2112)
+* [2388](http://www.ietf.org/rfc/rfc2388.txt): Returning Values from Forms: multipart/form-data
+* [2424](http://www.ietf.org/rfc/rfc2424.txt): Content Duration MIME Header Definition
+* [3462](http://www.ietf.org/rfc/rfc3462.txt): The Multipart/Report Media Type for the Reporting of Mail 
System Administrative Messages (Obsoletes rfc1892)
+* [3464](http://www.ietf.org/rfc/rfc3464.txt): An Extensible Message Format for Delivery Status Notifications
+* [3798](http://www.ietf.org/rfc/rfc3798.txt): Message Disposition Notification (Obsoletes rfc2298)
+* [4871](http://www.ietf.org/rfc/rfc4871.txt): DomainKeys Identified Mail (DKIM) Signatures
+* [5672](http://www.ietf.org/rfc/rfc5672.txt): RFC 4871 DomainKeys Identified Mail (DKIM) Signatures -- 
Update
+* [6376](http://www.ietf.org/rfc/rfc6376.txt): DomainKeys Identified Mail (DKIM) Signatures (Obsoletes 
rfc4871)
+* [6522](http://www.ietf.org/rfc/rfc6522.txt): The Multipart/Report Media Type for the Reporting of Mail 
System Administrative Messages (Obsoletes rfc3462)
+* [6532](http://www.ietf.org/rfc/rfc6532.txt): Internationalized Email Headers
+* [7103](http://www.ietf.org/rfc/rfc7103.txt): Advice for Safe Handling of Malformed Messages
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]