Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
C
capnproto
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
capnproto
Commits
7ff115cc
Commit
7ff115cc
authored
May 01, 2017
by
Kenton Varda
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update installation page more -- I think the caveats are obsolete.
parent
a6a7dcbf
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
35 deletions
+7
-35
install.md
doc/install.md
+7
-35
No files found.
doc/install.md
View file @
7ff115cc
...
...
@@ -5,41 +5,15 @@ title: Installation
# Installation: Tools and C++ Runtime
<div
style=
"float: right"
>
<a class="groups_link" style="color: #fff"
href="https://groups.google.com/group/capnproto-announce">Get Notified of Updates
</a></div>
The Cap'n Proto tools, including the compiler (which takes
`.capnp`
files and generates source code
for them), are written in C++. Therefore, you must install the C++ package even if your actual
development language is something else.
This package is licensed under the
[
MIT License
](
http://opensource.org/licenses/MIT
)
.
## Caveats
<p
style=
"font-size: 125%; font-weight: bold;"
>
Cap'n Proto is in BETA
</p>
<div
style=
"float: right"
>
<a class="groups_link" style="color: #fff"
href="https://groups.google.com/group/capnproto-announce">Sign Up for Updates
</a></div>
As of this writing, Cap'n Proto is in beta. The serialization layer is close to feature-complete
and we don't anticipate any further changes to the wire format. That said, if you want to use it,
you should keep in mind some caveats:
*
**Security:**
Cap'n Proto has not yet had a security review. Although Kenton has a background
in security and is not aware of any vulnerabilities in the current code, it's likely that there
are a few, and
[
some have been found
](
https://github.com/sandstorm-io/capnproto/tree/master/security-advisories
)
in the past. For now, do not accept Cap'n Proto messages from parties you do not trust.
*
**API Stability:**
The Cap'n Proto programming interface may still change in ways that break
existing code. Such changes are likely to be minor and should not affect the wire format.
*
**Performance:**
While Cap'n Proto is inherently fast by design, the implementation has not yet
undergone serious profiling and optimization. Currently it only beats Protobufs in realistic-ish
end-to-end benchmarks by around 2x-5x. We can do better.
*
**RPC:**
The RPC implementation particularly experimental, though it is used heavily by
[
Sandstorm.io
](
https://sandstorm.io
)
.
If you'd like to hack on Cap'n Proto, you should join the
[
discussion group
](
https://groups.google.com/group/capnproto
)
!
If you'd just like to receive updates as things progress, add yourself to the
[
announce list
](
https://groups.google.com/group/capnproto-announce
)
.
## Prerequisites
### Supported Compilers
...
...
@@ -48,7 +22,7 @@ Cap'n Proto makes extensive use of C++11 language features. As a result, it requ
new version of a well-supported compiler. The minimum versions are:
*
GCC 4.8
*
Clang 3.
3
*
Clang 3.
5
*
Visual C++ 2015
If your system's default compiler is older that the above, you will need to install a newer
...
...
@@ -67,12 +41,10 @@ as well as on Windows. We test every Cap'n Proto release on the following platfo
*
Windows - MinGW-w64
*
Windows - Visual C++
**Windows users:**
Cap'n Proto requires Visual Studio 2015 Update 3 or newer. All runtime features
of Cap'n Proto -- including serialization and RPC -- are now supported. (It is still not possible to
compile the code generator tool, capnp.exe, using Visual Studio; however, a precompiled copy built
with MinGW is provided in the release zip for your convenience.)
**Windows users:**
Cap'n Proto requires Visual Studio 2015 Update 3 or newer. All features
of Cap'n Proto -- including serialization, dynamic API, RPC, and schema parser -- are now supported.
**Mac OS X users:**
You
must use at least Xcode 5
with the Xcode command-line
**Mac OS X users:**
You
should use the latest Xcode
with the Xcode command-line
tools (Xcode menu > Preferences > Downloads). Alternatively, the command-line tools
package from
[
Apple
](
https://developer.apple.com/downloads/
)
or compiler builds from
[
Macports
](
http://www.macports.org/
)
,
[
Fink
](
http://www.finkproject.org/
)
, or
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment