Skip to content

Commit

Permalink
Update install instructions to note issue qitab#402
Browse files Browse the repository at this point in the history
  • Loading branch information
bkuehnert committed May 7, 2023
1 parent 98c2c64 commit 59ca5c1
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,24 @@ 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.
requires Google's protocol buffer compiler as well as the development headers.

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).
**Warning**
Due to `protoc`'s dependence on Abseil in v22, the headers required to install
the lisp plugin are no longer included. We are actively working on fixing
this dependency (#402). Until then, you will need to install a version of
protobuf older than v22, but at least v3.15.

The compiler and development headers can be installed via package manager.
### Ubuntu 22.04
```shell
sudo apt install protobuf-compiler libprotobuf-dev libprotoc-dev
```

### From source
To install from source, rough instructions are included here to install
protoc v21 on Unix systems. If you have any problems please see the
[protobuf installation instructions](https://github.com/protocolbuffers/protobuf/blob/21.x/src/README.md).

```shell
$ git clone --recursive https://github.com/google/protobuf
Expand All @@ -39,9 +51,13 @@ Common Lisp.

2. Build the Lisp `protoc` plugin

If you installed protoc via package manager, set `PROTOC_ROOT` to `/usr`. If
you installed it from source using the instructions above, use the value of
`--prefix` that you used.

```shell
$ cd cl-protobufs/protoc
$ PROTOC_ROOT=/usr/local make # value of --prefix, above
$ PROTOC_ROOT=/usr/local make
$ sudo cp protoc-gen-cl-pb /usr/local/bin/
```

Expand Down

0 comments on commit 59ca5c1

Please sign in to comment.