capnproto / capnproto-java

Cap'n Proto in pure Java
Other
398 stars 86 forks source link

Unclear manual on a website #63

Open Miha-x64 opened 6 years ago

Miha-x64 commented 6 years ago

Hello. This is the most stupid issue ever. I'm reading your website:

You will need to install the latest release of the Cap’n Proto schema compiler.

Success! Now I've got capnp.

Then, running make should build capnpc-java.

Um, running make from where? Oh, OK, I need to clone this repo, cd into it and run make. Now I've got ./capnpc-java.

On Windows,

Happy Linux-user, skipping...

Note that you’ll need to include java.capnp so that you can use the package and outerClassname annotations.

Include where?

using Java = import "/capnp/java.capnp";

yields

schema.capnp:2:21-40: error: Import failed: /capnp/java.capnp
schema.capnp:3:2-6: error: Not defined: Java
schema.capnp:4:2-6: error: Not defined: Java

/capnp/java.capnp looks like I need a directory called capnp at my mounting point (/), which looks strange.

using Java = import "./compiler/src/main/schema/capnp/java.capnp";

Oh, I need to include it here. Success!

Looks like there are several unclear places in your manual.

Thanks!