Improve documentation

[ufechner7]

Hello,
great that you started this project!

It is not clear to me how complete the current implementation is, or what is missing.
Please add some words about this to the Readme file.

Uwe

[tanmaykm]

Hi. I have implemented most of the commonly used protobuf features. Also updated the readme. Do take a look and give it a try.

[ufechner7]

Hello, currently I am using Julia 0.21, and not 0.3beta. Is there a good reason why it doesn't work with 0.2? Anyway, I will try it with Julia 0.3 tomorrow.
Thank you for the good work!

[tanmaykm]

That's temporary. It's because there are a few differences in Julia base APIs between 0.2 and 0.3 which I need to work around, which should not be difficult. One of the reasons I have not registered the package yet.

[tanmaykm]

It should work with v0.2 now.

[ufechner7]

I tried it a little bit, and it is working now! This is great!
But the documentation on how to use the protoc compiler should be improved:
I put a protofile into the current directory and had to use the following command to compile it into a julia file in the same directory:
protoc -I . asset.system.proto --julia_out .
(Note the dot at the end of the command!)
This worked only after I changed the file protoc-gen-julia to have the following content:
julia -e 'push!(LOAD_PATH, "/home/ufechner/00Julia/ProtoBuf.jl/src"); using ProtoBuf; using ProtoBuf.Gen; gen()'
Modifying the load path in ~/.juliarc or adding the load path in the environment variable JULIA_LOAD_PATH was not sufficient.

Perhaps you can add this information to the README.

Thank's again! Uwe

[tanmaykm]

You should not have to do the JULIA_LOAD_PATH thing if you install ProtoBuf as a Julia module.

You can use: `Pkg.add("https://github.com/tanmaykm/ProtoBuf.jl.git") to install it for now, till it gets registered in METADATA.

The protoc command in README.md was just for illustration. The necessity of specifying the include files and output folder explicitly are imposed by protoc, and not by ProtoBuf.jl.

[ufechner7]

I tried your suggestion, but it does not work:
julia> Pkg.add("https://github.com/tanmaykm/ProtoBuf.jl.git")
ERROR: unknown package https://github.com/tanmaykm/ProtoBuf.jl.git
in add at pkg/entry.jl:45
in add at pkg/entry.jl:48
in anonymous at pkg/dir.jl:28
in cd at file.jl:22
in cd at pkg/dir.jl:28
in add at pkg.jl:19

julia>

[tanmaykm]

Sorry, I meant Pkg.clone("https://github.com/tanmaykm/ProtoBuf.jl.git")

[ufechner7]

It would be good to add this to the README:
Installation:
Execute:
Pkg.clone("https://github.com/tanmaykm/ProtoBuf.jl.git")
from the Julia command prompt.
Add the following line to the end of the .bashrc file:
export PATH=$PATH:$HOME'/.julia/v0.2/ProtoBuf/plugin'

[tanmaykm]

ProtoBuf is now a registered package and can be installed as usual with Pkg.add.