Browse Source

rename python README, and fix markdown in java and python respectively

jesse 10 years ago
parent
commit
cd04e9b702
2 changed files with 18 additions and 7 deletions
  1. 7 1
      java/README.md
  2. 11 6
      python/README.md

+ 7 - 1
java/README.md

@@ -1,4 +1,8 @@
 Protocol Buffers - Google's data interchange format
+===================================================
+
+[![Build Status](https://travis-ci.org/google/protobuf.svg?branch=master)](https://travis-ci.org/google/protobuf)
+
 Copyright 2008 Google Inc.
 
 This directory contains the Java Protocol Buffers runtime library.
@@ -50,17 +54,19 @@ http://maven.apache.org/guides/introduction/introduction-to-profiles.html)
 
 E.g. to install the lite version of the jar, you would run:
 
-  $ mvn install -P lite
+    $ mvn install -P lite
 
 The resulting artifact has the 'lite' classifier.  To reference it
 for dependency resolution, you would specify it as:
 
+```
   <dependency>
     <groupId>com.google.protobuf</groupId>
     <artifactId>protobuf-java</artifactId>
     <version>${version}</version>
     <classifier>lite</classifier>
   </dependency>
+```
 
 Installation - Without Maven
 ============================

+ 11 - 6
python/README.txt → python/README.md

@@ -1,4 +1,8 @@
 Protocol Buffers - Google's data interchange format
+===================================================
+
+[![Build Status](https://travis-ci.org/google/protobuf.svg?branch=master)](https://travis-ci.org/google/protobuf)
+
 Copyright 2008 Google Inc.
 
 This directory contains the Python Protocol Buffers runtime library.
@@ -65,9 +69,11 @@ Installation
 
 5) Install:
 
-     $ python setup.py install
-     or:
-     $ python setup.py install --cpp_implementation
+    $ python setup.py install
+
+  or:
+
+    $ python setup.py install --cpp_implementation
 
    This step may require superuser privileges.
    NOTE: To use C++ implementation, you need to install C++ protobuf runtime
@@ -93,8 +99,8 @@ To use the C++ implementation, you need to:
    parent directory.
 2) Export an environment variable:
 
-  $ export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=cpp
-  $ export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION_VERSION=2
+    $ export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=cpp
+    $ export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION_VERSION=2
 
 You need to export this variable before running setup.py script to build and
 install the extension.  You must also set the variable at runtime, otherwise
@@ -103,4 +109,3 @@ change the default so that C++ implementation is used whenever it is available.
 It is strongly recommended to run `python setup.py test` after setting the
 variable to "cpp", so the tests will be against C++ implemented Python
 messages.
-