Skip to content

Commit

Permalink
rename python README, and fix markdown in java and python respectively
Browse files Browse the repository at this point in the history
  • Loading branch information
numberten committed Mar 16, 2015
1 parent bf05592 commit cd04e9b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
8 changes: 7 additions & 1 deletion java/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
============================
Expand Down
17 changes: 11 additions & 6 deletions python/README.txt → python/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.

0 comments on commit cd04e9b

Please sign in to comment.