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.

Sign up for GitHub

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

Jump to bottom

Documentation assumes reader has used protobufs, thus there are gaps for users who are new to protobufs #1496

Open
leisurehound opened this issue Nov 6, 2023 · 1 comment
Open

Documentation assumes reader has used protobufs, thus there are gaps for users who are new to protobufs #1496

leisurehound opened this issue Nov 6, 2023 · 1 comment

Comments

@leisurehound
Copy link

at https://github.com/apple/swift-protobuf/tree/main there is language 'If you've worked with Protocol Buffers before, adding Swift support is very simple:'

However, if you're new to protobufs, the page doesn't assist the new user to go to https://github.com/protocolbuffers/protobuf/releases/ and download the compiler and install. It may seem obvious to do so for many, but as one who is first using protobufs (over MQTT) it was not.

It would also be helpful to have instructions on how to setup Xcode so the protoc compiler is run as a prebuild step, which files to .gitignore, for SPM projects setup exclusions, etc. A language specific tutorial at https://protobuf.dev/getting-started/ would be best. Realize thats an Apple v Google to get that site updated.
@tbkka
Copy link
Contributor

tbkka commented Nov 6, 2023

I'd love to have a step-by-step walkthrough for folks who are familiar with developing on Apple platforms with Xcode but possibly new to protobuf. I'd suggest that we add a GETTING_STARTED_XCODE.md file to the Documentation directory -- we can then link to it from our own home page and possibly ask Google to link from their protobuf documentation as well.

I've actually found in the past that the best folks to write such a document are folks who have just recently gone through the experience themselves. They have the best appreciation of what might be confusing. If you'd like to take a crack at drafting up such a document and putting up a PR, I'm sure you'll get lots of feedback and help to refine it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@leisurehound @tbkka