Commit ba987a7e authored by Feng Xiao's avatar Feng Xiao Committed by GitHub

Merge pull request #3126 from mbrukman/fix-readme-formatting

Fix Markdown formatting in README.
parents c5125f37 67755700
...@@ -35,13 +35,11 @@ Installation ...@@ -35,13 +35,11 @@ Installation
$ python -V $ python -V
2) If you do not have setuptools installed, note that it will be 2) If you do not have setuptools installed, note that it will be
downloaded and installed automatically as soon as you run setup.py. downloaded and installed automatically as soon as you run `setup.py`.
If you would rather install it manually, you may do so by following If you would rather install it manually, you may do so by following
the instructions on this page: the instructions on [this page](https://packaging.python.org/en/latest/installing.html#setup-for-installing-packages).
https://packaging.python.org/en/latest/installing.html#setup-for-installing-packages 3) Build the C++ code, or install a binary distribution of `protoc`. If
3) Build the C++ code, or install a binary distribution of protoc. If
you install a binary distribution, make sure that it is the same you install a binary distribution, make sure that it is the same
version as this package. If in doubt, run: version as this package. If in doubt, run:
...@@ -53,35 +51,43 @@ Installation ...@@ -53,35 +51,43 @@ Installation
$ python setup.py test $ python setup.py test
To build, test, and use the C++ implementation, you must first compile To build, test, and use the C++ implementation, you must first compile
libprotobuf.so: `libprotobuf.so`:
$ (cd .. && make) $ (cd .. && make)
On OS X: On OS X:
If you are running a homebrew-provided python, you must make sure another If you are running a Homebrew-provided Python, you must make sure another
version of protobuf is not already installed, as homebrew's python will version of protobuf is not already installed, as Homebrew's Python will
search /usr/local/lib for libprotobuf.so before it searches ../src/.libs search `/usr/local/lib` for `libprotobuf.so` before it searches
You can either unlink homebrew's protobuf or install the libprotobuf you `../src/.libs`.
You can either unlink Homebrew's protobuf or install the `libprotobuf` you
built earlier: built earlier:
$ brew unlink protobuf $ brew unlink protobuf
or or
$ (cd .. && make install) $ (cd .. && make install)
On other *nix: On other *nix:
You must make libprotobuf.so dynamically available. You can either You must make `libprotobuf.so` dynamically available. You can either
install libprotobuf you built earlier, or set LD_LIBRARY_PATH: install libprotobuf you built earlier, or set `LD_LIBRARY_PATH`:
$ export LD_LIBRARY_PATH=../src/.libs $ export LD_LIBRARY_PATH=../src/.libs
or or
$ (cd .. && make install) $ (cd .. && make install)
To build the C++ implementation run: To build the C++ implementation run:
$ python setup.py build --cpp_implementation $ python setup.py build --cpp_implementation
Then run the tests like so: Then run the tests like so:
$ python setup.py test --cpp_implementation $ python setup.py test --cpp_implementation
If some tests fail, this library may not work correctly on your If some tests fail, this library may not work correctly on your
...@@ -89,9 +95,10 @@ Installation ...@@ -89,9 +95,10 @@ Installation
Please note that there is a known problem with some versions of Please note that there is a known problem with some versions of
Python on Cygwin which causes the tests to fail after printing the Python on Cygwin which causes the tests to fail after printing the
error: "sem_init: Resource temporarily unavailable". This appears error: `sem_init: Resource temporarily unavailable`. This appears
to be a bug either in Cygwin or in Python: to be a [bug either in Cygwin or in
http://www.cygwin.com/ml/cygwin/2005-07/msg01378.html Python](http://www.cygwin.com/ml/cygwin/2005-07/msg01378.html).
We do not know if or when it might be fixed. We also do not know We do not know if or when it might be fixed. We also do not know
how likely it is that this bug will affect users in practice. how likely it is that this bug will affect users in practice.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment