THRIFT-2407 use markdown (rename README => README.md)
authorRoger Meier <roger@apache.org>
Sun, 16 Mar 2014 20:12:11 +0000 (21:12 +0100)
committerRoger Meier <roger@apache.org>
Wed, 19 Mar 2014 05:47:47 +0000 (06:47 +0100)
Patch: Roger Meier

45 files changed:
Makefile.am
README.md [moved from README with 97% similarity]
compiler/cpp/Makefile.am
compiler/cpp/README.md [moved from compiler/cpp/README with 100% similarity]
compiler/cpp/README_Windows.md [moved from compiler/cpp/README_Windows.txt with 100% similarity]
contrib/Rebus/README.md [moved from contrib/Rebus/README with 100% similarity]
contrib/Stomp/README.md [moved from contrib/Stomp/README with 100% similarity]
contrib/fb303/README.md [moved from contrib/fb303/README with 100% similarity]
contrib/transport-sample/README.md [moved from contrib/transport-sample/README.txt with 100% similarity]
contrib/zeromq/README.md [moved from contrib/zeromq/README with 100% similarity]
debian/README.md [moved from debian/README with 100% similarity]
lib/c_glib/Makefile.am
lib/c_glib/README.md [moved from lib/c_glib/README with 100% similarity]
lib/cocoa/README.md [moved from lib/cocoa/README with 100% similarity]
lib/cpp/Makefile.am
lib/cpp/README.SSL.md [moved from lib/cpp/README.SSL with 100% similarity]
lib/cpp/README.md [moved from lib/cpp/README with 100% similarity]
lib/cpp/README_WINDOWS.md [moved from lib/cpp/README_WINDOWS with 100% similarity]
lib/csharp/README.md [moved from lib/csharp/README with 100% similarity]
lib/d/Makefile.am
lib/d/README.md [moved from lib/d/README with 100% similarity]
lib/delphi/test/codegen/README.md [moved from lib/delphi/test/codegen/README.txt with 100% similarity]
lib/delphi/test/skip/README.md [moved from lib/delphi/test/skip/README.txt with 100% similarity]
lib/erl/README.md [moved from lib/erl/README with 100% similarity]
lib/go/Makefile.am
lib/go/README.md [moved from lib/go/README with 100% similarity]
lib/hs/Makefile.am
lib/hs/README.md [moved from lib/hs/README with 100% similarity]
lib/java/README.md [moved from lib/java/README with 100% similarity]
lib/js/Gruntfile.js
lib/js/README.md [moved from lib/js/README with 100% similarity]
lib/js/test/README.md [moved from lib/js/test/README with 100% similarity]
lib/ocaml/README.md [moved from lib/ocaml/README with 100% similarity]
lib/perl/README.md [moved from lib/perl/README with 100% similarity]
lib/php/Makefile.am
lib/php/README.apache.md [moved from lib/php/README.apache with 100% similarity]
lib/php/README.md [moved from lib/php/README with 100% similarity]
lib/py/README.md [moved from lib/py/README with 100% similarity]
lib/rb/README.md [moved from lib/rb/README with 100% similarity]
lib/rb/thrift.gemspec
lib/st/README.md [moved from lib/st/README with 100% similarity]
tutorial/README.md [moved from tutorial/README with 98% similarity]
tutorial/erl/README.md [moved from tutorial/erl/README with 100% similarity]
tutorial/java/README.md [moved from tutorial/java/README with 100% similarity]
tutorial/ocaml/README.md [moved from tutorial/ocaml/README with 100% similarity]

index ec0b319..6bc8754 100755 (executable)
@@ -50,4 +50,5 @@ EXTRA_DIST = \
        sonar-project.properties \
        LICENSE \
        CHANGES \
-       NOTICE
+       NOTICE \
+       README.md
similarity index 97%
rename from README
rename to README.md
index 4d81081..3520c01 100644 (file)
--- a/README
+++ b/README.md
@@ -1,6 +1,7 @@
 Apache Thrift
+=============
 
-Last Modified: 2013-Dec-17
+Last Modified: 2014-03-16
 
 License
 =======
@@ -36,7 +37,7 @@ Thrift is specifically designed to support non-atomic version changes
 across client and server code.
 
 For more details on Thrift's design and implementation, take a gander at
-the Thrift whitepaper included in this distribution or at the README files
+the Thrift whitepaper included in this distribution or at the README.md files
 in your particular subdirectory of interest.
 
 Hierarchy
@@ -134,7 +135,7 @@ Note that some language packages must be installed manually using build tools
 better suited to those languages (at the time of this writing, this applies
 to Java, Ruby, PHP).
 
-Look for the README file in the lib/<language>/ folder for more details on the
+Look for the README.md file in the lib/<language>/ folder for more details on the
 installation of each language library package.
 
 Testing
index 4c0e71d..95b78ee 100644 (file)
@@ -106,7 +106,7 @@ WINDOWS_DIST = \
              compiler.sln \
              compiler.vcxproj \
              compiler.vcxproj.filters \
-             README_Windows.txt
+             README_Windows.md
 
 EXTRA_DIST = \
              $(WINDOWS_DIST)
similarity index 100%
rename from compiler/cpp/README
rename to compiler/cpp/README.md
similarity index 100%
rename from contrib/Rebus/README
rename to contrib/Rebus/README.md
similarity index 100%
rename from contrib/Stomp/README
rename to contrib/Stomp/README.md
similarity index 100%
rename from contrib/fb303/README
rename to contrib/fb303/README.md
similarity index 100%
rename from debian/README
rename to debian/README.md
index 3244f74..35f1114 100755 (executable)
@@ -85,7 +85,7 @@ include_processor_HEADERS = src/thrift/c_glib/processor/thrift_processor.h
 
 
 EXTRA_DIST = \
-             README \
+             README.md \
              test/glib.suppress \
              thrift_c_glib.pc.in
 
similarity index 100%
rename from lib/c_glib/README
rename to lib/c_glib/README.md
similarity index 100%
rename from lib/cocoa/README
rename to lib/cocoa/README.md
index 7b879f3..9810745 100755 (executable)
@@ -225,7 +225,7 @@ include_qt_HEADERS = \
 THRIFT = $(top_builddir)/compiler/cpp/thrift
 
 WINDOWS_DIST = \
-             README_WINDOWS \
+             README_WINDOWS.md \
              src/thrift/windows \
              thrift.sln \
              libthrift.vcxproj \
@@ -234,8 +234,8 @@ WINDOWS_DIST = \
              libthriftnb.vcxproj.filters
 
 EXTRA_DIST = \
-             README \
-             README.SSL \
+             README.md \
+             README.SSL.md \
              thrift-nb.pc.in \
              thrift.pc.in \
              thrift-z.pc.in \
similarity index 100%
rename from lib/cpp/README.SSL
rename to lib/cpp/README.SSL.md
similarity index 100%
rename from lib/cpp/README
rename to lib/cpp/README.md
similarity index 100%
rename from lib/csharp/README
rename to lib/csharp/README.md
index a4e3188..04c0639 100644 (file)
@@ -180,4 +180,4 @@ TESTS = $(addprefix unittest/debug/, $(d_test_modules)) \
 EXTRA_DIST = \
        src \
        test \
-       README
+       README.md
similarity index 100%
rename from lib/d/README
rename to lib/d/README.md
similarity index 100%
rename from lib/erl/README
rename to lib/erl/README.md
index efb58be..bb386cf 100644 (file)
@@ -24,7 +24,7 @@ endif
 install:
        @echo '##############################################################'
        @echo '##############################################################'
-       @echo 'The Go client library should be installed via "go get", please see /lib/go/README'
+       @echo 'The Go client library should be installed via "go get", please see /lib/go/README.md'
        @echo '##############################################################'
        @echo '##############################################################'
 
@@ -34,4 +34,4 @@ check-local:
 all-local: check-local
 
 EXTRA_DIST = \
-       thrift
\ No newline at end of file
+       thrift
similarity index 100%
rename from lib/go/README
rename to lib/go/README.md
index 3db1df9..70c51c7 100644 (file)
@@ -19,7 +19,7 @@
 
 EXTRA_DIST = \
   LICENSE \
-  README \
+  README.md \
   Setup.lhs \
   TODO \
   Thrift.cabal \
similarity index 100%
rename from lib/hs/README
rename to lib/hs/README.md
similarity index 100%
rename from lib/java/README
rename to lib/java/README.md
index 321063f..3298d5c 100644 (file)
@@ -20,7 +20,7 @@ module.exports = function(grunt) {
     },
     jsdoc : {
         dist : {
-            src: ['src/*.js', './README'], 
+            src: ['src/*.js', './README.md'],
             options: {
               destination: 'doc'
             }
similarity index 100%
rename from lib/js/README
rename to lib/js/README.md
similarity index 100%
rename from lib/js/test/README
rename to lib/js/test/README.md
similarity index 100%
rename from lib/ocaml/README
rename to lib/ocaml/README.md
similarity index 100%
rename from lib/perl/README
rename to lib/perl/README.md
index 927de98..2b6b5fa 100755 (executable)
@@ -119,7 +119,7 @@ EXTRA_DIST = \
   src/Thrift.php \
   src/TStringUtils.php \
   thrift_protocol.ini \
-  README.apache
+  README.apache.md
 
 MAINTAINERCLEANFILES = \
   Makefile \
similarity index 100%
rename from lib/php/README
rename to lib/php/README.md
similarity index 100%
rename from lib/py/README
rename to lib/py/README.md
similarity index 100%
rename from lib/rb/README
rename to lib/rb/README.md
index a91ea07..43e5a7f 100644 (file)
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.test_files = Dir.glob("{test,spec,benchmark}/**/*")
   s.executables =  Dir.glob("{bin}/**/*")
 
-  s.extra_rdoc_files  = %w[README] + Dir.glob("{ext,lib}/**/*.{c,h,rb}")
+  s.extra_rdoc_files  = %w[README.md] + Dir.glob("{ext,lib}/**/*.{c,h,rb}")
 
   s.require_paths = %w[lib ext]
 
similarity index 100%
rename from lib/st/README
rename to lib/st/README.md
similarity index 98%
rename from tutorial/README
rename to tutorial/README.md
index a29f977..7772bf3 100644 (file)
@@ -25,7 +25,7 @@ Tutorial
 
 1) First things first, you'll need to install the Thrift compiler and the
    language libraries. Do that using the instructions in the top level
-   README file.
+   README.md file.
 
 2) Read tutorial.thrift to learn about the syntax of a Thrift file
 
similarity index 100%
rename from tutorial/erl/README
rename to tutorial/erl/README.md
similarity index 100%
rename from tutorial/java/README
rename to tutorial/java/README.md