Introduction
A Java (Maven) source repository on GitHub. It provides:
- command-line launchers for Anchor
- procedure for making an Anchor Distribution
- all the BeanXML for default tasks and configuration
What belongs in the repository?
Tip: It should include: command-line programs for launching and configuring anchor launcher application (entry-point application), Maven directives to build an Anchor Distribution, any default configuration and tasks.
Warning: It should not include: data objects, algorithms related to image processing.
Supporting libraries and tooling
-
A SonarCloud project performs static code analysis.
-
Project Lombok reduces boiler-plate source code. Please see key libraries for relevant libraries and tooling.
-
Coding style specifies the applicable style-guide.
-
GitHub Actions and Maven for CI/CD.
Modules
| Module | Java Package Root & Description | Classes | Lines‑of‑Code |
|---|---|---|---|
| anchor-launcher | org.anchoranalysis.launcherThe anchor command-line application. |
38 | 1,627 |
Number of classes/code is as per SonarQube, June 24th, 2020. Lines-of-code excludes whitespace and comments.
Resources
| Resource Location | Description |
|---|---|
| config | What becomes the config/ directory in a distribution |
| models | What becomes the models/ directory in a distribution |
| helperapps | Files placed into the bin/ directory to help start anchor correctly-configured |
| topleveldocs | Documentation placed in the root directory (i.e. /) of a distribution |
Key Maven configuration-files
| Resource Location | Description |
|---|---|
| addplugins/pom.xml | Where non GPL-plugins are listed to be included. |
| anchor-assembly/pom.xml | Building .exe launchers, and GPL-plugins listed to be included. |
| Distribution XML files | Specifies what files are contained in a distribution. |