|
12 | 12 | [](https://sonarcloud.io/summary/overall?id=eclipse-sisu_sisu.inject) |
13 | 13 | [](https://www.eclipse.org/legal/epl-v10.html) |
14 | 14 |
|
15 | | -Sisu is a modular [JSR330](https://javax-inject.github.io/javax-inject/)-based container that supports classpath scanning, auto-binding, and dynamic auto-wiring. |
| 15 | +Sisu is a modular [JSR-330](https://javax-inject.github.io/javax-inject/)-based container that supports classpath scanning, auto-binding, and dynamic auto-wiring. |
16 | 16 |
|
17 | | -Sisu uses [Google-Guice](https://github.com/google/guice) to perform dependency injection and provide the core JSR330 support, but removes the need to write explicit bindings in Guice modules. Integration with other containers via the Eclipse Extension Registry and the OSGi Service Registry is a goal of this project. |
18 | | - |
19 | | -## Maven |
20 | | - |
21 | | -```xml |
22 | | -<dependency> |
23 | | - <groupId>org.eclipse.sisu</groupId> |
24 | | - <artifactId>org.eclipse.sisu.inject</artifactId> |
25 | | - <version>0.3.5</version> |
26 | | -</dependency> |
27 | | -``` |
| 17 | +Sisu uses [Google Guice](https://github.com/google/guice) to perform dependency injection and provide the core JSR-330 support, but removes the need to write explicit bindings in Guice modules. Integration with other containers via the Eclipse Extension Registry and the OSGi Service Registry is a goal of this project. |
28 | 18 |
|
29 | 19 | ## Documentation |
30 | 20 |
|
31 | | -[Sisu in 5 minutes](https://eclipse.github.io/sisu.inject/) |
32 | | - |
33 | | -[Javadoc](https://eclipse.github.io/sisu.inject/apidocs/) |
34 | | - |
35 | | -### Generation of Named Index |
36 | | - |
37 | | -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: |
38 | | - |
39 | | -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). |
40 | | -2. By leveraging the dedicated Maven plugin <https://github.com/eclipse/sisu.mojos/> |
41 | | - |
42 | | -## Related projects |
43 | | - |
44 | | -https://github.com/eclipse/sisu.mojos/ |
45 | | - * a [Maven](https://maven.apache.org/) plugin that generates annotation indexes for Sisu to avoid classpath scanning at runtime |
46 | | - |
47 | | -https://github.com/eclipse/sisu.plexus/ |
48 | | - * an extension that implements [Plexus](https://codehaus-plexus.github.io/#Plexus_History) container API and injection semantics on top of Sisu |
| 21 | +* [Sisu Website](https://eclipse.github.io/sisu.inject/) (soon also available on <https://eclipse.dev/sisu/>) |
| 22 | +* [Eclipse Project Information](https://projects.eclipse.org/projects/technology.sisu) |
49 | 23 |
|
50 | 24 | ## How to Contribute |
51 | 25 |
|
52 | 26 | We accept contributions via GitHub pull requests. Please see [How To Contribute](CONTRIBUTING.md) to get started. |
53 | 27 |
|
54 | 28 | ## License |
55 | 29 |
|
56 | | -- [Eclipse Public License, v1.0](https://www.eclipse.org/legal/epl-v10.html) |
57 | | - |
58 | | -## Meaning of sisu |
59 | | -<sub>From https://en.wikipedia.org/w/index.php?title=Sisu&oldid=371994592</sub> |
60 | | - |
61 | | -> Sisu is a Finnish term loosely translated into English as strength of will, determination, perseverance, and acting rationally in the face of adversity. However, the word is widely considered to lack a proper translation into any language. Sisu has been described as being integral to understanding Finnish culture. The literal meaning is equivalent in English to "having guts", and the word derives from sisus, which means something inner or interior. However sisu is defined by a long-term element in it; it is not momentary courage, but the ability to sustain an action against the odds. Deciding on a course of action and the sticking to that decision against repeated failures is sisu. It is similar to equanimity, except the forbearance of sisu has a grimmer quality of stress management than the latter. The noun sisu is related to the adjective sisukas, one having the quality of sisu. |
62 | | -
|
63 | | -## Additional information |
64 | | - |
65 | | -* Project Website: https://www.eclipse.org/sisu |
66 | | -* Mailing Lists: https://dev.eclipse.org/mailman/listinfo/sisu-dev |
67 | | -* Eclipse PMI: https://projects.eclipse.org/projects/technology.sisu |
68 | | - |
| 30 | +- [Eclipse Public License, v2.0](https://www.eclipse.org/legal/epl-v20.html) |
0 commit comments