From 659ae125228bf9c1e9d1be917871190b008a8c00 Mon Sep 17 00:00:00 2001 From: Ritesh Shukla Date: Wed, 22 Mar 2017 14:23:36 -0700 Subject: Fix markdown to comply with GitHub --- INSTALL.md | 24 ++++++++++++------------ README.md | 14 +++++++------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 24f088ea49..89f2f11f9d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,4 @@ -#If you are in a hurry +# If you are in a hurry For language-specific installation instructions for gRPC runtime, please refer to these documents @@ -14,15 +14,15 @@ refer to these documents * [Ruby](src/ruby): `gem install grpc` -#Pre-requisites +# Pre-requisites -##Linux +## Linux ```sh $ [sudo] apt-get install build-essential autoconf libtool ``` -##Mac OSX +## Mac OSX For a Mac system, git is not available by default. You will first need to install Xcode from the Mac AppStore and then run the following command from a @@ -32,7 +32,7 @@ terminal: $ [sudo] xcode-select --install ``` -##Protoc +## Protoc By default gRPC uses [protocol buffers](https://github.com/google/protobuf), you will need the `protoc` compiler to generate stub server and client code. @@ -43,7 +43,7 @@ repository recursively and it detects that you don't already have it installed. -#Build from Source +# Build from Source For developers who are interested to contribute, here is how to compile the gRPC C Core library. @@ -56,16 +56,16 @@ gRPC C Core library. $ [sudo] make install ``` -##Windows +## Windows There are several ways to build under Windows, of varying complexity depending on experience with the tools involved. -###Pre-generated Visual Studio solution +### Pre-generated Visual Studio solution The pre-generated VS projects & solution are checked into the repository under the [vsprojects](/vsprojects) directory. - -###Building using CMake (with BoringSSL) + +### Building using CMake (with BoringSSL) - Install [CMake](https://cmake.org/download/). - Install [Active State Perl](http://www.activestate.com/activeperl/) (`choco install activeperl`) - Install [Ninja](https://ninja-build.org/) (`choco install ninja`) @@ -81,14 +81,14 @@ The pre-generated VS projects & solution are checked into the repository under t ``` NOTE: Currently you can only use Ninja to build using cmake on Windows (because of the boringssl dependency). -###msys2 (with mingw) +### msys2 (with mingw) The Makefile (and source code) should support msys2's mingw32 and mingw64 compilers. Building with msys2's native compiler is also possible, but difficult. This approach requires having [msys2](https://msys2.github.io/) installed. - + ``` # Install prerequisites MSYS2$ pacman -S autoconf automake gcc libtool mingw-w64-x86_64-toolchain perl pkg-config zlib diff --git a/README.md b/README.md index 174e861f59..2d73d7a7ad 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ Copyright 2015 Google Inc. -#Documentation +# Documentation You can find more detailed documentation and examples in the [doc](doc) and [examples](examples) directories respectively. -#Installation & Testing +# Installation & Testing See [INSTALL](INSTALL.md) for installation instructions for various platforms. @@ -19,7 +19,7 @@ See [tools/run_tests](tools/run_tests) for more guidance on how to run various t See [Performance dashboard](http://performance-dot-grpc-testing.appspot.com/explore?dashboard=5712453606309888) for the performance numbers for v1.0.x. -#Repository Structure & Status +# Repository Structure & Status This repository contains source code for gRPC libraries for multiple languages written on top of shared C core library [src/core] (src/core). @@ -44,7 +44,7 @@ Go source code is in the [grpc-go] (http://github.com/grpc/grpc-go) repository. See [MANIFEST.md](MANIFEST.md) for a listing of top-level items in the repository. -#Overview +# Overview Remote Procedure Calls (RPCs) provide a useful abstraction for building @@ -54,7 +54,7 @@ These libraries enable communication between clients and servers using any combination of the supported languages. -##Interface +## Interface Developers using gRPC typically start with the description of an RPC service @@ -66,7 +66,7 @@ Interface Definition Language (IDL) for describing both the service interface and the structure of the payload messages. It is possible to use other alternatives if desired. -###Surface API +### Surface API Starting from an interface definition in a .proto file, gRPC provides Protocol Compiler plugins that generate Client- and Server-side APIs. gRPC users typically call into these APIs on the Client side and implement @@ -94,7 +94,7 @@ the client and the server can send a stream of messages to each other. The strea messages are delivered in the order they were sent. -#Protocol +# Protocol The [gRPC protocol](doc/PROTOCOL-HTTP2.md) specifies the abstract requirements for communication between clients and servers. A concrete embedding over HTTP/2 completes the picture by -- cgit v1.2.3