third_party/content_analysis_sdk/agent/README.md

   1 # Google Chrome Content Analysis Connector Agent SDK
   2
   3 This directory holds the Google Chrome Content Analysis Connector Agent SDK.
   4 An Agent is an OS process running on the same computer as Google Chrome
   5 that listens for and processes content analysis requests from the browser.
   6 Supported OSes are Windows, Mac, and Linux.
   7
   8 ## Google Protocol Buffers
   9
  10 This SDK depends on Google Protocol Buffers version 3.18 or later.  It may be
  11 installed from Google's [download page](https://developers.google.com/protocol-buffers/docs/downloads#release-packages)
  12 for your developement platform.  It may also be installed using a package
  13 manager.
  14
  15 The included demo uses the Microsoft [vcpkg](https://github.com/microsoft/vcpkg)
  16 package manager to install protobuf.  vcpkg is available on all supported
  17 platforms.  See the demo for more details.
  18
  19 ## Adding the SDK into an agent
  20
  21 Add the SDK to a content analysis agent as follows:
  22
  23 1. Clone the SDK from [Github](https://github.com/chromium/content_analysis_sdk).
  24 This document assumes that the SDK is downloaded and extracted into the
  25 directory $SDK_DIR.
  26
  27 2. Add the directory $SDK_DIR/include to the include path of the agent
  28 code base.
  29
  30 3. Add all the source files in the directory $SDK_DIR/src to the agent build.
  31 Note that files ending in _win.cc or _win.h are meant only for Windows, files
  32 ending in _posix.cc or _posix.h are meant only for Linux, and files ending in
  33 _mac.cc or _mac.h are meant only for Mac.
  34
  35 4. Reference the SDK in agent code using:
  36 ```
  37 #include "content_analysis/sdk/local_analysis.h"
  38 ```