Move logo to above the table of contents
* Logo is now embedded in the template and above the table of contents
* Move logo in README to be at the top and separated with a hr. This looks
okay when rendered by GitHub and when rendered by Pandoc.
* README.md has gotten long enough that it can use a table of contents
* Use inline bash syntax highlighting for README.md: this doesn't highlight
extra things like the python mode was doing, and looks reasonable for all
the snippets, including the Windows CMD snippets
* This also lets us to get rid of the index.html template--it was almost
identical to the default.html template, but had some formatting colors
overridden to black.
Closes https://github.com/Microsoft/bond/pull/237
This commit is contained in:
Christopher Warrington
Chad Walters
Родитель
857e87fd2b
Коммит
72675f5b42
148
README.md
148
README.md
|
|
@ -1,9 +1,11 @@
|
|||
|
||||
<hr />
|
||||
|
||||
[](https://travis-ci.org/Microsoft/bond)
|
||||
[](https://Microsoft.github.io/bond/manual/bond_cs.html#nuget-packages)
|
||||
|
||||
# Bond
|
||||
|
||||
|
||||
Bond is an open source, cross-platform framework for working with schematized
|
||||
data. It supports cross-language serialization/deserialization and powerful
|
||||
generic mechanisms for efficiently manipulating data. Bond is broadly used at
|
||||
|
|
@ -37,7 +39,9 @@ For a discussion how Bond compares to similar frameworks see [Why Bond](https://
|
|||
The Bond repository uses Git submodules and should be cloned with the
|
||||
`--recursive` flag:
|
||||
|
||||
git clone --recursive https://github.com/Microsoft/bond.git
|
||||
```bash
|
||||
git clone --recursive https://github.com/Microsoft/bond.git
|
||||
```
|
||||
|
||||
In order to build Bond you will need CMake (2.8.12+), Haskell (ghc 7.4+ and
|
||||
cabal-install 1.18+) and Boost (1.54+). The core Bond C++ library can be used
|
||||
|
|
@ -54,25 +58,29 @@ version of Clang as it's much faster with template-heavy code like Bond.
|
|||
Run the following commands to install the minimal set of packages needed to
|
||||
build the core Bond library on Ubuntu 14.04:
|
||||
|
||||
sudo apt-get install \
|
||||
clang \
|
||||
cmake \
|
||||
zlib1g-dev \
|
||||
ghc \
|
||||
cabal-install \
|
||||
libboost-dev \
|
||||
libboost-thread-dev
|
||||
```bash
|
||||
sudo apt-get install \
|
||||
clang \
|
||||
cmake \
|
||||
zlib1g-dev \
|
||||
ghc \
|
||||
cabal-install \
|
||||
libboost-dev \
|
||||
libboost-thread-dev
|
||||
|
||||
cabal update
|
||||
cabal install cabal-install
|
||||
cabal update
|
||||
cabal install cabal-install
|
||||
```
|
||||
|
||||
In the root `bond` directory run:
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
sudo make install
|
||||
```bash
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
||||
The `build` directory is just an example. Any directory can be used as the build
|
||||
destination.
|
||||
|
|
@ -80,18 +88,22 @@ destination.
|
|||
In order to build all the C++ and Python tests and examples, a few more
|
||||
packages are needed:
|
||||
|
||||
sudo apt-get install \
|
||||
python2.7-dev \
|
||||
libboost-date-time-dev \
|
||||
libboost-test-dev \
|
||||
libboost-python-dev
|
||||
```bash
|
||||
sudo apt-get install \
|
||||
python2.7-dev \
|
||||
libboost-date-time-dev \
|
||||
libboost-test-dev \
|
||||
libboost-python-dev
|
||||
|
||||
cabal install happy
|
||||
cabal install happy
|
||||
```
|
||||
|
||||
Running the following command in the build directory will build and execute all
|
||||
the tests and examples:
|
||||
|
||||
make --jobs 8 check
|
||||
```bash
|
||||
make --jobs 8 check
|
||||
```
|
||||
|
||||
(The unit tests are large so you may want to run 4-8 build jobs in parallel,
|
||||
assuming you have enough memory.)
|
||||
|
|
@ -101,49 +113,63 @@ assuming you have enough memory.)
|
|||
Install Xcode and then run the following command to install the required
|
||||
packages using Homebrew ([http://brew.sh/](http://brew.sh/)):
|
||||
|
||||
brew install \
|
||||
cmake \
|
||||
ghc \
|
||||
cabal-install \
|
||||
boost \
|
||||
boost-python
|
||||
```bash
|
||||
brew install \
|
||||
cmake \
|
||||
ghc \
|
||||
cabal-install \
|
||||
boost \
|
||||
boost-python
|
||||
```
|
||||
|
||||
(boost-python is optional and only needed for Python support.)
|
||||
|
||||
Update the cabal package database and install `happy` (only needed for tests):
|
||||
|
||||
cabal update
|
||||
cabal install happy
|
||||
```bash
|
||||
cabal update
|
||||
cabal install happy
|
||||
```
|
||||
|
||||
Bond can be built on OS X using either standard \*nix makefiles or Xcode. In
|
||||
order to generate and build from makefiles, in the root `bond` directory run:
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
sudo make install
|
||||
```bash
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
sudo make install
|
||||
```
|
||||
|
||||
Alternatively, you can generate Xcode projects by passing the `-G Xcode` option
|
||||
to cmake:
|
||||
|
||||
cmake -G Xcode ..
|
||||
```bash
|
||||
cmake -G Xcode ..
|
||||
```
|
||||
|
||||
You can build and run unit tests by building the `check` target in Xcode or by
|
||||
running make in the build directory:
|
||||
|
||||
make --jobs 8 check
|
||||
```bash
|
||||
make --jobs 8 check
|
||||
```
|
||||
|
||||
Note that if you are using Homebrew's Python, you'll need to build
|
||||
boost-python from source:
|
||||
|
||||
brew install --build-from-source boost-python
|
||||
```bash
|
||||
brew install --build-from-source boost-python
|
||||
```
|
||||
|
||||
and tell cmake the location of Homebrew's libpython by setting the
|
||||
`PYTHON_LIBRARY` variable, e.g.:
|
||||
|
||||
cmake .. \
|
||||
-DPYTHON_LIBRARY=/usr/local/Cellar/python/2.7.9/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib
|
||||
```bash
|
||||
cmake .. \
|
||||
-DPYTHON_LIBRARY=/usr/local/Cellar/python/2.7.9/Frameworks/Python.framework/Versions/2.7/lib/libpython2.7.dylib
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
|
|
@ -158,11 +184,15 @@ Install the following tools:
|
|||
If you are building on a network behind a proxy, set the environment variable
|
||||
`HTTP_PROXY`, e.g.:
|
||||
|
||||
set HTTP_PROXY=http://your-proxy-name:80
|
||||
```bash
|
||||
set HTTP_PROXY=http://your-proxy-name:80
|
||||
```
|
||||
|
||||
Update the cabal package database:
|
||||
|
||||
cabal update
|
||||
```bash
|
||||
cabal update
|
||||
```
|
||||
|
||||
Now you are ready to build the C# version of Bond. Open the solution file
|
||||
`cs\cs.sln` in Visual Studio and build as usual. The C# unit tests can
|
||||
|
|
@ -177,8 +207,10 @@ You may need to set the environment variables `BOOST_ROOT` and `BOOST_LIBRARYDIR
|
|||
to specify where Boost and its pre-built libraries for your environment (MSVC 12 or MSVC 14) can be
|
||||
found, e.g.:
|
||||
|
||||
set BOOST_ROOT=D:\boost_1_57_0
|
||||
set BOOST_LIBRARYDIR=D:\boost_1_57_0\lib64-msvc-14.0
|
||||
```bash
|
||||
set BOOST_ROOT=D:\boost_1_57_0
|
||||
set BOOST_LIBRARYDIR=D:\boost_1_57_0\lib64-msvc-14.0
|
||||
```
|
||||
|
||||
The core Bond library and most examples only require Boost headers. The
|
||||
pre-built libraries are only needed for unit tests and Python support. If Boost
|
||||
|
|
@ -188,29 +220,37 @@ not be built.
|
|||
In order to generate a solution to build the C++ and Python versions with Visual
|
||||
Studio 2015 run the following commands from the root `bond` directory:
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
set PreferredToolArchitecture=x64
|
||||
cmake -G "Visual Studio 14 2015 Win64" ..
|
||||
```bash
|
||||
mkdir build
|
||||
cd build
|
||||
set PreferredToolArchitecture=x64
|
||||
cmake -G "Visual Studio 14 2015 Win64" ..
|
||||
```
|
||||
|
||||
Setting `PreferredToolArchitecture=x64` selects the 64-bit toolchain which
|
||||
dramatically improves build speed. (The Bond unit tests are too big to build
|
||||
with 32-bit tools.) This variable works for Visual Studio 2013 or 2015. For
|
||||
Visual Studio 2012 set the following environment variable instead:
|
||||
|
||||
set _IsNativeEnvironment=true
|
||||
```bash
|
||||
set _IsNativeEnvironment=true
|
||||
```
|
||||
|
||||
Instead of `cmake` you can also use `cmake-gui` and specify configuration
|
||||
settings in the UI. This configuration step has to be performed only once. From
|
||||
then on you can use the generated solution `build\bond.sln` from Visual Studio
|
||||
or build from command line using `cmake`:
|
||||
|
||||
cmake --build . --target
|
||||
cmake --build . --target INSTALL
|
||||
```bash
|
||||
cmake --build . --target
|
||||
cmake --build . --target INSTALL
|
||||
```
|
||||
|
||||
In order to build and execute the unit tests and examples run:
|
||||
|
||||
cmake --build . --target check -- /maxcpucount:8
|
||||
```bash
|
||||
cmake --build . --target check -- /maxcpucount:8
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ $if(highlighting-css)$
|
|||
$highlighting-css$
|
||||
$endif$
|
||||
body {
|
||||
line-height: 1.5;
|
||||
font-family: Helvetica, Arial, sans-serif;
|
||||
line-height: 1.5;
|
||||
font-family: Helvetica, Arial, sans-serif;
|
||||
color: #333333;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
|
@ -33,7 +33,7 @@ $endif$
|
|||
padding: 25px;
|
||||
overflow: auto;
|
||||
}
|
||||
code > span.kw { color: #204a87; font-weight: normal; } /* Keyword */
|
||||
code > span.kw { color: #204a87; font-weight: normal; } /* Keyword */
|
||||
code > span.co { color: #4E9A06; font-style: normal; }
|
||||
code > span.st { color: #8A0303; font-style: normal; }
|
||||
code > span.cf { color: #204a87; font-weight: normal; } /* ControlFlow */
|
||||
|
|
@ -56,19 +56,19 @@ $endif$
|
|||
max-height: 620px;
|
||||
}
|
||||
|
||||
table.sourceCode {
|
||||
table.sourceCode {
|
||||
line-height: 120%;
|
||||
}
|
||||
}
|
||||
|
||||
#toc {
|
||||
width: 300px;
|
||||
width: 300px;
|
||||
position:fixed;
|
||||
overflow: auto;
|
||||
height: 95%;
|
||||
}
|
||||
|
||||
#main {
|
||||
margin-left: 320px;
|
||||
margin-left: 320px;
|
||||
margin-rigth: auto;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
|
@ -90,7 +90,7 @@ $endif$
|
|||
margin-right: auto;
|
||||
}
|
||||
#toc {
|
||||
left: -300px;
|
||||
left: -300px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
|
@ -120,14 +120,15 @@ $endfor$
|
|||
$for(include-before)$
|
||||
$include-before$
|
||||
$endfor$
|
||||
$if(toc)$
|
||||
<div id="$idprefix$toc">
|
||||
<p><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA7DAAAOwwHHb6hkAAAAB3RJTUUH4AkNAgoHQuWiyQAACYlJREFUeNrtm3twVNUdxz/33t3N7pL3OyRkISQQKiBoCGApoK2KVKlUHhVQwFZQWywWxnGm7egwtkWdoVREitFQXhYoRRSICsFYaSU2nQRMAoEEyIu8YEM2m93N3rt7T/9IGo20dKG0JGW/M/vH3Xv3nHs+5/f7nd/53buSEEJwE0vmJlcQQBBAEEAQQBBAEEAQQBBAEEAQQBDAzSnD9WjE4XDwccFHFBWXcMF+CVVVURQFi9lMRHgYMVFRJCbEkZSURGxMLGaLhcSkJEJDQ284AOl6bIfnPfw9CpzhmBMGoxiNSJKMEAIhdHSfD+FT8Xs9aB1tCHc7ZmcTM7JHsG79673acblc5OcfInN4JsMzM/uuBfg0jUsOBzU1tVxqbeXjk3XEz3wmANwSsjGExkPbsKUOuuz0htdf57kXX8EvKdBuJ9mWyrjbbyM76zbmzplDWlrajQXg8XjIy8tj48YccFfwrRG1FJRHog+cHVgDQiA0L81H9pKw+NvU1taSmprac9rrdpE05SHiJs3A7+5AdbZyvP0SB7ft5/PjZbz66lri4mL/Ny7g8/nQNI2GhgZ2797Nzp07KS0tZXx2FsWfn+FkjorN5mDYghik+1dhjo4PqEPnuXJCinYRExXF8ePH6ezsJDU1lXHjxlF2rBh1yvexpmQgdL3rBhUDF3avZkJEGUeOuxmamcW77+0nPj7++ltAW1sb+fn5HD16lJMVFWjeTqwWM7IsM3bMKH70xA8YPnwYix7/MbaUKs6eGUCVI5xbEwehq96AOrx4soh1zz7LwoULAfD7/VRXV3PixAmWFRYSmTIMofu/mCFZZohUzh9/5oEQhTU7ypkzdx4fHT6ILMvXF8CuXbtYunQpyckDeWX1L0hMiKel5QJeVWXIYBvVNbU0NrVwyyAPCJV3PhEkTbgb4fcH7ALGjgssX76cRYsWkZycTHZ2NhMnTuzy77ghIF1mpJh0N7ouI6t+MlMVVmz4EwaDgbCwMEaPHk12djZZWVlkZWWRlpaGoijXBmDJkiXMmjWLvLw83t1/gJaWJgZYzdw+diwREeEMSx9K+clKRtmc4JP5S6lG9NQ7es3YlccvSIkKpbDoPA0NDZw+fYrKyiqqa2rYtnUr3uSsHtP/0q/wMADV58asgKZ6WfLEk2zc8Cr19fVUVlZy6tQpiouL2bNnD2VlZaxatYrZs2dfWxCMjo5mwYIFzJ8/H1VVqampYf369Ty66HEGD7YxJC2DxVkevG5o0aJRBkQh/CqSLHeDkK6wCEg0+kKIS0hEtoSB1G3CXhd+JFImPwZfCUnC7+ec5Q7ONRcwwuanzm7kD7t2IgmVcePGMX78eO68886e63fs2EF7e/t/Jw/Iz89nzdp1TE7+iGUP6Ez55RB8019EkmTObn6B2An3E5YxFmQFdB9eeyNqWwt6pxtjZByWgUORDSZkg6EblOgxcyF0/N5OEPpl/Xoddpz7Xmb9gjpe2K6w7q2DlJaWUl5eTlVVFXa7HbPZTGRkJK2trSxdurQnxlz3RMjlcjF/3lwO5R1AirOR/tRa/B4XJ1Y/Suay39B5sQFHxV9xVBRhSbARarsFU3Q89sIDDJr7LMaImMtmOYDbRNe8tB7dS2PBbhY+soA3czf1+LqqqqiqitfrRdM0oqKiCAkJ+e9mgg6Hg3vuuZv2OxZjSbTR+rd82ko/wRAWTeiQkUSMGI9iCUP3a6DrNHywicSpc5BMli/N/FViMJiQZYm6g9sZKdv58P0DmEymG5cKlxQXM/Xe6bitcSTcPpXIjLGYYgYCAuHzIYTeNdvdKbEkK9c8+N53LdN45B0mmC/x3r79N34v8H7eAfbu2UPRZ4U4OlwISyT6gCh0SwS6JQzMYSihkRgsoUjGECRFwWAwoSMjyXIXGElCMRpQQqwB9amYrVSs/SEf7NjE5ClTbyyAXumy243D4cDpdOLq6MDldtHhdGK327l48SKtbQ7cnV5yc9/gvolm/H5weE2oPoljZyF5yVqETw3IClR7A+Nbj5K7ees1J0UGrrMsVisWq5XEpKR/ec2nn37KmSOr2bq8eyWQAKFw7wo/LeiBOYnQMUbFU/DJOTRNCzjo3fCCiBCCmbPm89JSC/gATQJVAj8MMIHf1Q6SFJj5SjJ2JYLCwsL+UxH69dr1LJjsIN3muSweWq0GvK1NSAECAIgaOpI338rtHwBqa2vZvWUVLy1ygrd7kGaotYfwyGpBQVkYXnvjFxliAAq3ZbJ3796+D8DlcjF2zGjWPu7CIHftHTp9ISx/LYwxT4Xw8E/2serFX+Fqqg7YBQBCohPpUP3U19X1jSD4z9Ta2so3757OynmxONrP8PPN8Hl9NJ3WSXxnxgNc3PEYsixTcPgwrrpKJFlBoAUWU3Sd8KGjOFZSQsqgQX0TQE5ODseKP0N1Z1B/1xPMXPwQP500CaPR2Gvr+rWRI/GcP4t0FW0LoRNqG8GJ8lLunzHjxucB/6mMFivDn/ltwAmRJCu46k5yl+80G3N/1/+fC3x94kTcLfVXZQGW+EE0NTVyLXPZ5wBMv28arqbarnKZpyOgKpNiCcPp7kTTtP4P4LsPPoizrhKQaPxwc0DVJiHAo8v4fL7+DyA5JYUkkwYIJEnC1+G4fFn86rEQeIWMP9DaZF8GYDKZGJUYjvC6ic66h5odL6EYzV0VJEkGBN6W+i8gSBKSwYQqGdD/HwAoisK0adNo+fNeQtPHEnnrFKpynkO1N+CpLuP0a8vpbKlBkhX8nW7c58/Q8mEuSnvLVSVQfXYZhK4nUFExsaQ//RqGsGhc1eW4qstRTBYiRn8DraOdM/nvMSb8LEnyeUTkVDZt2UpsbOxV7SP6LACALVu28OTLOaTPWtZdZNXRnHaa9m0gjZNsXGFmjK2DbUdieHKNE7ens28URK6nnn56GW+8X4g1OZ22yuPcO/giK2Z6cDi97CsUHCpRGJg2nt9ve4v09PRr3p/3aRUXF4ucnBzx9ttvC0BYrVaxePFikZGRIboLjMJisYiVK1eK06dPCyGE0HVd6Lre08Y/jhsbG3t9L4QQUn96XV4I0ePjeXl5rFmzhsOHD/euSFkspKenEx8fj9lsRlVVmpubqaioQFVVtm/fzrx58/qPBVxJmqaJpqYm8fzzz4vExMQei7jSp6ioqP9awL9TQ0MDJSUlVFVV0dzcjMfjwWQykZCQQGZmJpMnT77stRwp+I+Rm1xBAEEAQQBBAEEAQQBBAEEAQQBBAEEAN6f+DmFDv1c4Q3HPAAAAAElFTkSuQmCC" alt="The Bond logo: a stylized glue gun" /></p>
|
||||
$if(toc)$
|
||||
$toc$
|
||||
</div>
|
||||
$endif$
|
||||
</div>
|
||||
<div id="main">
|
||||
$if(title)$
|
||||
<div id="$idprefix$header">
|
||||
<div id="$idprefix$header">
|
||||
<h1 class="title">$title$</h1>
|
||||
$for(author)$
|
||||
<h2 class="author">$author$</h2>
|
||||
|
|
@ -138,7 +139,7 @@ $endif$
|
|||
</div>
|
||||
$endif$
|
||||
$body$
|
||||
</div>
|
||||
</div>
|
||||
$for(include-after)$
|
||||
$include-after$
|
||||
$endfor$
|
||||
|
|
|
|||
|
|
@ -1,154 +0,0 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"$if(lang)$ lang="$lang$" xml:lang="$lang$"$endif$>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta http-equiv="Content-Style-Type" content="text/css" />
|
||||
<meta name="generator" content="pandoc" />
|
||||
$for(author-meta)$
|
||||
<meta name="author" content="$author-meta$" />
|
||||
$endfor$
|
||||
$if(date-meta)$
|
||||
<meta name="date" content="$date-meta$" />
|
||||
$endif$
|
||||
<title>$if(title-prefix)$$title-prefix$ - $endif$$if(pagetitle)$$pagetitle$$endif$</title>
|
||||
<style type="text/css">
|
||||
$if(highlighting-css)$
|
||||
$highlighting-css$
|
||||
$endif$
|
||||
body {
|
||||
line-height: 1.5;
|
||||
font-family: Helvetica, Arial, sans-serif;
|
||||
color: #333333;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
code {
|
||||
font-size: 1em;
|
||||
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace, serif;
|
||||
}
|
||||
td.lineNumbers { width: 40px; }
|
||||
div#all {
|
||||
max-width: 1120px;
|
||||
background-color: #ffffff;
|
||||
margin: 0 auto;
|
||||
padding: 25px;
|
||||
overflow: auto;
|
||||
}
|
||||
code > span.kw { color: #000000; font-style:normal; }
|
||||
code > span.dt { color: #000000; font-style:normal; }
|
||||
code > span.dv { color: #000000; font-style:normal; }
|
||||
code > span.bn { color: #000000; font-style:normal; }
|
||||
code > span.fl { color: #000000; font-style:normal; }
|
||||
code > span.ch { color: #000000; font-style:normal; }
|
||||
code > span.st { color: #000000; font-style:normal; }
|
||||
code > span.co { color: #000000; font-style:normal; }
|
||||
code > span.ot { color: #000000; font-style:normal; }
|
||||
code > span.al { color: #000000; font-style:normal; }
|
||||
code > span.fu { color: #000000; font-style:normal; }
|
||||
code > span.er { color: #000000; font-style:normal; }
|
||||
code > span.cf { color: #000000; font-weight: normal; } /* ControlFlow */
|
||||
code > span.op { color: #000000; font-weight: normal; } /* Operator */
|
||||
code > span.pp { color: #000000; font-style: normal; } /* Preprocessor */
|
||||
code > span.at { color: #000000; } /* Attribute */
|
||||
code > span.do { color: #000000; font-weight: normal; font-style: normal; } /* Documentation */
|
||||
code > span.an { color: #000000; font-weight: normal; font-style: normal; } /* Annotation */
|
||||
code > span.cv { color: #000000; font-weight: normal; font-style: normal; } /* CommentVar */
|
||||
code > span.in { color: #000000; font-weight: normal; font-style: normal; } /* Information */
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-weight: normal;
|
||||
border-bottom: 1px solid black;
|
||||
}
|
||||
|
||||
div.sourceCode {
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
table.sourceCode {
|
||||
line-height: 120%;
|
||||
}
|
||||
|
||||
#toc {
|
||||
width: 300px;
|
||||
position:fixed;
|
||||
overflow: auto;
|
||||
height: 95%;
|
||||
}
|
||||
|
||||
#main {
|
||||
margin-left: 320px;
|
||||
margin-rigth: auto;
|
||||
max-width: 800px;
|
||||
}
|
||||
a {
|
||||
text-decoration: none;
|
||||
}
|
||||
#toc a:visited {
|
||||
color: #99c;
|
||||
}
|
||||
#main a:visited {
|
||||
color: #36c;
|
||||
}
|
||||
a:link {
|
||||
color: #36c;
|
||||
}
|
||||
@media screen and (max-width: 979px){
|
||||
#main {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
#toc {
|
||||
left: -300px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
$for(css)$
|
||||
<link rel="stylesheet" href="$css$" $if(html5)$$else$type="text/css" $endif$/>
|
||||
$endfor$
|
||||
$if(math)$
|
||||
$math$
|
||||
$endif$
|
||||
$for(header-includes)$
|
||||
$header-includes$
|
||||
$endfor$
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-58775439-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<nav id="TOC"/>
|
||||
<div id="all">
|
||||
$for(include-before)$
|
||||
$include-before$
|
||||
$endfor$
|
||||
$if(toc)$
|
||||
<div id="$idprefix$toc">
|
||||
$toc$
|
||||
</div>
|
||||
$endif$
|
||||
<div id="main">
|
||||
$if(title)$
|
||||
<div id="$idprefix$header">
|
||||
<h1 class="title">$title$</h1>
|
||||
$for(author)$
|
||||
<h2 class="author">$author$</h2>
|
||||
$endfor$
|
||||
$if(date)$
|
||||
<h3 class="date">$date$</h3>
|
||||
$endif$
|
||||
</div>
|
||||
$endif$
|
||||
$body$
|
||||
</div>
|
||||
$for(include-after)$
|
||||
$include-after$
|
||||
$endfor$
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -108,19 +108,17 @@ if (Haskell_PANDOC_EXECUTABLE AND Doxygen_EXECUTABLE)
|
|||
|
||||
add_pandoc_markdown (src/reference_index.md
|
||||
CODE cpp
|
||||
OPTIONS --self-contained
|
||||
OPTIONS --self-contained "--title-prefix=Bond Reference Index"
|
||||
OUTPUT_NAME index
|
||||
OUTPUT_DIR reference)
|
||||
|
||||
add_pandoc_markdown (../README.md
|
||||
TEMPLATE index.html
|
||||
OUTPUT_NAME index
|
||||
CODE python)
|
||||
OPTIONS --table-of-contents "--title-prefix=Bond, Microsoft's cross-platform framework for working with schematized data")
|
||||
|
||||
add_pandoc_markdown (src/why_bond.md
|
||||
TEMPLATE index.html
|
||||
CODE python
|
||||
OPTIONS --self-contained)
|
||||
OPTIONS --self-contained --table-of-contents)
|
||||
|
||||
set (doxygen_sources
|
||||
doxygen/bond.doxygen
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Bond Communications
|
||||
|
||||
\
|
||||
|
||||
|
||||
# About #
|
||||
|
||||
The Bond Communications framework allows clients and services to exchange
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Bond Epoxy transport
|
||||
|
||||
\
|
||||
|
||||
|
||||
# About #
|
||||
|
||||
The Bond Epoxy transport is a Bond
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Bond Epoxy transport wire format
|
||||
|
||||
\
|
||||
|
||||
|
||||
# Epoxy transport wire format #
|
||||
|
||||
This documents the [Bond Epoxy transport](bond_comm_epoxy.html) wire format.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Bond Comm Roadmap
|
||||
|
||||
\
|
||||
|
||||
|
||||
# Roadmap
|
||||
|
||||
This is what we currently are working on for Bond Comm.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Bond Simple In Memory (SimpleInMem) transport
|
||||
|
||||
\
|
||||
|
||||
|
||||
# About #
|
||||
|
||||
The Bond SimpleInMem transport is a Bond
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% A Young Person's Guide to C++ Bond
|
||||
|
||||
\
|
||||
|
||||
|
||||
About
|
||||
=====
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% A Young Person's Guide to C# Bond
|
||||
|
||||
\
|
||||
|
||||
|
||||
About
|
||||
=====
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Python bindings for Bond
|
||||
|
||||
\
|
||||
|
||||
|
||||
About
|
||||
=====
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
% Bond compiler
|
||||
|
||||
\
|
||||
|
||||
|
||||
Command line options
|
||||
====================
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,3 @@
|
|||
\
|
||||
|
||||
|
||||
Bond Reference
|
||||
==============
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
%Why Bond?
|
||||
|
||||
\
|
||||
|
||||
|
||||
Bond is an [open source framework](https://github.com/Microsoft/bond/) which
|
||||
addresses similar scenarios to Protocol Buffers, Thrift and Avro. In this
|
||||
document we try to address similarities and differences between Bond and other
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче