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

Fix old links to old repos in README.md #158

Closed
wants to merge 1 commit into from
Closed

Fix old links to old repos in README.md #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,18 @@ Sisu uses [Google-Guice](https://github.com/google/guice) to perform dependency

## Documentation

[Sisu in 5 minutes](https://eclipse.github.io/sisu.inject/)
[Sisu in 5 minutes](https://eclipse-sisu.github.io/sisu-project/index.html)

[Javadoc](https://eclipse.github.io/sisu.inject/apidocs/)
[Javadoc](https://eclipse-sisu.github.io/sisu-project/javadoc.html)

[Plexus to JSR330](https://eclipse-sisu.github.io/sisu-project/plexus/index.html)

### Generation of Named Index

Often Sisu's `SpaceModule` doesn't scan the full classpath at run time (for relevant annotations) but relies on a pre-generated index at `META-INF/sisu/javax.inject.Named`. There are two different ways how to create such an index file:

1. By leveraging the Java annotation processor in [org.eclipse.sisu.space.SisuIndexAPT6](https://github.com/eclipse/sisu.inject/blob/master/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors).
2. By leveraging the dedicated Maven plugin <https://github.com/eclipse/sisu.mojos/>
1. By leveraging the Java annotation processor in [org.eclipse.sisu.space.SisuIndexAPT6](https://github.com/eclipse-sisu/sisu-project/blob/main/org.eclipse.sisu.inject/src/main/java/org/eclipse/sisu/space/SisuIndexAPT6.java) to generate the index. One needs to enable via [`javac -processor org.eclipse.sisu.space.SisuIndexAPT6`](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#annotation-processing) or with the according [`maven-compiler-plugin` parameter `annotationProcessors`](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#annotationProcessors).
2. By leveraging the dedicated Maven plugin <https://github.com/eclipse-sisu/sisu-project/tree/main/org.eclipse.sisu.mojos>

## Related projects

Expand Down
Loading