Browse Source

Merge pull request #306 from grpc/MrMage-patch-1

Tweak Echo Readme
Tim Burks 7 years ago
parent
commit
9b7a73143b
3 changed files with 7 additions and 13 deletions
  1. 3 3
      Examples/EchoXcode/README.md
  2. 1 7
      Examples/README.md
  3. 3 3
      Examples/SimpleXcode/README.md

+ 3 - 3
Examples/EchoXcode/README.md

@@ -3,8 +3,8 @@
 The Echo Xcode project contains a Mac app that can be used to
 The Echo Xcode project contains a Mac app that can be used to
 instantiate and run local gRPC clients and servers. It depends
 instantiate and run local gRPC clients and servers. It depends
 on the gRPC Xcode project, which requires a local build of the
 on the gRPC Xcode project, which requires a local build of the
-gRPC Core C library. To build that, please run "make" in the
+gRPC Core C library. To build that, please run `make` in the
 root of your gRPC distribution. Next use Xcode's "Add Files..."
 root of your gRPC distribution. Next use Xcode's "Add Files..."
 command to add the SwiftGRPC.xcodeproj to your project and
 command to add the SwiftGRPC.xcodeproj to your project and
-then add the gRPC, CgRPC, BoringSSL, and SwiftProtobuf
-libraries to the target dependencies of "Echo".
+then add the SwiftGRPC, CgRPC, BoringSSL, and SwiftProtobuf
+libraries to the "Linked Frameworks and Libraries" build phase of "Echo".

+ 1 - 7
Examples/README.md

@@ -1,12 +1,7 @@
 
 
 # Examples
 # Examples
 
 
-To build the Xcode examples, make sure required third party libraries
-(specifically `swift-protobuf`) are retrieved by running the script in the
-`third_party` toplevel directory:
-
-    $ cd third_party
-    $ sh RUNME.sh
+To build the Xcode examples, you will need to add the `SwiftGRPC` project (and possibly the `SwiftProtobuf` project from https://github.com/apple/swift-protobuf as well) to the corresponding Xcode projects. This is explained in more detail in the individual directories' `README.md` files.
 
 
 ## Swift gRPC generated code examples
 ## Swift gRPC generated code examples
 
 
@@ -28,4 +23,3 @@ Samples that call Google gRPC APIs are in the [Google](Google) directory.
 [Simple](Simple)
 [Simple](Simple)
 The Simple sample demonstrates the low-level gRPC APIs with clients and servers
 The Simple sample demonstrates the low-level gRPC APIs with clients and servers
 that can be built with Xcode or the Swift Package Manager.
 that can be built with Xcode or the Swift Package Manager.
- 

+ 3 - 3
Examples/SimpleXcode/README.md

@@ -8,11 +8,11 @@ Swift gRPC plugin for protoc.
 The Simple Xcode project contains a Mac app that can be used to 
 The Simple Xcode project contains a Mac app that can be used to 
 instantiate and run local gRPC clients and servers. It depends
 instantiate and run local gRPC clients and servers. It depends
 on the gRPC Xcode project, which requires a local build of the
 on the gRPC Xcode project, which requires a local build of the
-gRPC Core C library. To build that, please run "make" in the
+gRPC Core C library. To build that, please run `make` in the
 root of your gRPC distribution. Next use Xcode's "Add Files..."
 root of your gRPC distribution. Next use Xcode's "Add Files..."
 command to add the SwiftGRPC.xcodeproj to your project and
 command to add the SwiftGRPC.xcodeproj to your project and
-then add the gRPC, CgRPC, and BoringSSL libraries to the target
-dependencies of "Simple".
+then add the SwiftGRPC, CgRPC, BoringSSL and SwiftProtobuf libraries to the
+"Linked Frameworks and Libraries" build phase of "Simple".
 
 
 When running the app, use the "New" menu option to create new
 When running the app, use the "New" menu option to create new
 gRPC sessions. Configure each session using the host and port
 gRPC sessions. Configure each session using the host and port