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

where are the installation instructions? #1698

Closed
xdavidliu opened this issue Apr 19, 2023 · 4 comments
Closed

where are the installation instructions? #1698

xdavidliu opened this issue Apr 19, 2023 · 4 comments

Comments

@xdavidliu
Copy link

if I were a beginner and had openJDK 20 on macOS, how do I actually get started with Guice? Do I need to clone the repo and then use Bazel or something? Pretty non-obvious from the documentation here; even "Getting Started" doesn't mention any installation instructions at all, and it doesn't seem entirely obvious to me.

@xdavidliu
Copy link
Author

xdavidliu commented Apr 20, 2023

If this repo is purely for people developing Guice itself (as opposed to using it as a dependency in their own application, which is significantly more common), perhaps a simple blurb in the README with something like "this repo is for developing Guice itself; if you want to USE Guice, see such and such directions for Maven etc etc" ???

this would save newcomers a significant amount of confusion and time wasted?

@xdavidliu
Copy link
Author

it looks like the guides in this repo are targeted for people that want to use Guice, not people that want to develop Guice. In that case, there really should be at least one sentence on how to "get started" here.

@sameb
Copy link
Member

sameb commented Apr 20, 2023

The wiki has a getting started page: https://github.com/google/guice/wiki/GettingStarted. Though it doesn't seem to include the Maven blurb. That's on latest release page @ https://github.com/google/guice/wiki/Guice510. I'll see about adding a Maven blurb to GettingStarted or the project README.

copybara-service bot pushed a commit that referenced this issue May 5, 2023
…ing:

* Bumps the snapshot version to 7.0.1-SNAPSHOT
* Adds Guice 6 & Guice 7 release pages, with explanations of the jakarta transition & how Guice 6.0 & 7.0 should be used. They also include changelogs since 5.1.0.
* Updates the top-level README to reference the 6.0 & 7.0 releases, as well as including "installation instructions" (which fixes #1698).
* Updates the wiki to make sure it's meaningful for both javax & jakarta references, pointing to the correct ones where appropriate.

PiperOrigin-RevId: 529758826
@xdavidliu
Copy link
Author

xdavidliu commented Jun 30, 2023

The GettingStarted page still doesn't say anything about how to actually get started with Guice, i.e. the very first step of adding a Maven dependency or whatever.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants