From aa9f29695cdb35250c90e027cb53cda9fb158586 Mon Sep 17 00:00:00 2001 From: Alexander Kriegisch Date: Mon, 24 May 2021 13:49:08 +0700 Subject: Add "how to release" guide and point to it from README.md Also fix a few minor wording and formatting things in the main read-me. Signed-off-by: Alexander Kriegisch --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index daf99bb47..2641506dc 100644 --- a/README.md +++ b/README.md @@ -10,38 +10,41 @@ AspectJ enables: ## Building -AspectJ has a multi module maven build. Although various modules produce intermediate results, the key artifacts at the end of the build are: +AspectJ has a multi-module Maven build. Although various modules produce intermediate results, the key artifacts at the end of the build are: * `aspectjrt` - the AspectJ runtime * `aspectjweaver` - the AspectJ weaver * `aspectjtools` - the AspectJ compiler +* `aspectjmatcher` - the AspectJ matcher -These are the artifacts published to maven central for each release. In addition there is an installer that can be run with `java -jar` to install AspectJ onto Windows/Mac/Linux. This installer is produced by the installer sub module. +These are the artifacts published to Maven Central for each release. In addition, there is an installer that can be run with `java -jar` to install AspectJ onto Windows/Mac/Linux. This installer is produced by the `installer` sub-module. In the root of a cloned AspectJ simply run: `./mvnw clean install` This will build all the modules, run all the tests and install the key artifacts in your local repository. -Once built access the maven dependencies from your local repository or run the installer to install AspectJ locally: +Once built, access the Maven dependencies from your local repository or run the installer to install AspectJ locally: ``` java -jar installer/target/aspectj-.jar ``` -## Running the tests in eclipse +## Running the tests in Eclipse Once you have imported all the projects using `m2e`, there is a special module called `run-all-junit-tests` and within that a `RunTheseBeforeYouCommitTests` class that can be run with the JUnit launcher to execute thousands of tests. Ensure you run this with a JDK - the more recent the better since some tests will not execute on older JDKs - tests that verify language features that only exist in the more up to date JDK version. -## Documentation +## Documentation for AspectJ users -[Complete documentation quicklinks](https://www.eclipse.org/aspectj/docs.php) +* [Complete documentation quicklinks](https://www.eclipse.org/aspectj/docs.php) +* [Getting started with AspectJ](https://www.eclipse.org/aspectj/doc/released/progguide/starting.html) +* [Programming Guide](https://www.eclipse.org/aspectj/doc/released/progguide/index.html) +* [READMEs for each version of AspectJ](docs/dist/doc) -[Getting started with AspectJ](https://www.eclipse.org/aspectj/doc/released/progguide/starting.html) +## Documentation for AspectJ developers -[Programming Guide](https://www.eclipse.org/aspectj/doc/released/progguide/index.html) - -[READMEs for each version of AspectJ](https://github.com/eclipse/org.aspectj/tree/master/docs/dist/doc) +* [How to contribute to AspectJ](CONTRIBUTING.md) +* [How to release AspectJ](docs/developer/RELEASE.md) ## Maven releases -- cgit v1.2.3