Skip to content

Commit

Permalink
Correct README.md #8090
Browse files Browse the repository at this point in the history
  • Loading branch information
rymsha committed Sep 19, 2023
1 parent ac50f8f commit b36becd
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,42 @@ please read our docs here: https://developer.enonic.com/start.

Before trying to build the project, you need to verify that the following software are installed:

* Java 11 for building and running.
* Gradle 6.x build system.
* Git installed on system.
* [JDK 11](https://adoptium.net/temurin/archive/?version=11) for building and [GraalVM Java 17](https://www.graalvm.org/downloads/) for running.
* [Git](https://git-scm.com/downloads) installed on system.

Build all code and run all tests including integration tests:

gradle build
.\gradlew build

Build all code skipping all tests:

gradle build -x check
.\gradlew build -x check

Build all code skipping integration tests:

gradle build -x integrationTest
.\gradlew build -x integrationTest

Main output of the build process is located in the `moduels/runtime/build` directory
* `install` contains pure runtime of the Enonic XP platform.
* `distributions` contains a zip file ready for packaging byt xp-distro project.

Jsdoc output is located in the `modules/lib/build/distributions` directory.

## Running

This project is just the runtime of the Enonic XP platform. In order to run the system properly,
please see the xp-distro project that bundles the necessary part together: (https://github.com/enonic/xp-distro)

## Documentation

* [Developer Guide](https://developer.enonic.com/docs/xp/stable)
* [Release Notes](https://developer.enonic.com/docs/xp/stable/release)
* [JSDoc](https://developer.enonic.com/jsdoc/)

## License

This software is licensed under GPL v3. See [LICENSE.txt](https://github.com/enonic/xp/raw/master/LICENSE.txt).
Also the distribution includes 3rd party software components. The vast majority of these libraries are licensed under
Also, the distribution includes 3rd party software components. The vast majority of these libraries are licensed under
Apache 2.0. For a complete list please read [NOTICE.txt](https://github.com/enonic/xp/raw/master/NOTICE.txt).

All our libraries (`lib-*`) that can be bundled in your own applications are licensed as Apache 2.0.
Expand Down

0 comments on commit b36becd

Please sign in to comment.