Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PROTOC install documentation #440

Merged
merged 1 commit into from
Sep 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,23 @@ Common Lisp.
Common Lisp code for a given `.proto` file is generated by a plug-in for
`protoc`, the protocol buffer compiler. The plug-in is written in C++ and
requires the full version of Google's protocol buffer code to be installed
in order to build it, not just the precompiled protoc binaries.
in order to build, not just the precompiled protoc binaries. We also
require Google's ABSL C++ library to be installed.

Download and build Google protobuf. Rough instructions are included here for
Unix systems. If you have any problems please see the
[protobuf installation instructions](https://github.com/protocolbuffers/protobuf/tree/master/src).

```shell
$ git clone --recursive https://github.com/google/protobuf
$ cd protobuf
$ ./autogen.sh
$ ./configure --prefix=/usr/local
$ make
$ make check
$ sudo make install
$ sudo ldconfig
```
Depending on your package manager, you may be able to install these libraries
through `apt` (or your system's package manager). If you need to isntall
from source you can see the example in our continuous integration tests.

Make sure the `protoc` binary is on your `PATH`.

2. Build the Lisp `protoc` plugin

We use CMake to install the Lisp protoc plugin.

```shell
$ cd cl-protobufs/protoc
$ PROTOC_ROOT=/usr/local make # value of --prefix, above
$ sudo cp protoc-gen-cl-pb /usr/local/bin/
$ cmake . -DCMAKE_CXX_STANDARD=17
$ cmake --build . --target install --parallel 16
```

Make sure the installation directory is on your `PATH`.
Expand Down
Loading