diff --git a/README.md b/README.md index 3b9fc5dbaa..6957f5135e 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,34 @@ -[![Revved up by Gradle Enterprise](https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.grails.org/scans) - -#### Build Status -- ![Java CI](https://github.com/grails/grails-core/workflows/Java%20CI/badge.svg) -- ![Grails Joint Validation Build](https://github.com/grails/grails-core/workflows/Grails%20Joint%20Validation%20Build/badge.svg) - -#### Slack Signup -- [Slack Signup](https://slack.grails.org/) - -Grails +Grace Framework === -[Grails](https://grails.org/) is a framework used to build web applications with the [Groovy](https://groovy-lang.org/) programming language. The core framework is very extensible and there are numerous [plugins](https://plugins.grails.org/) available that provide easy integration of add-on features. - -Grails development is lead by the [Grails Foundation](https://grails.org/foundation/) and is sponsored by [Object Computing Inc.](https://objectcomputing.com/) in St. Louis Missouri. Please contact <2gm@objectcomputing.com> for support inquiries. +[Grace](https://github.com/graceframework/grace-framework) is a fork of Grails 5.1.x that started development in early 2022, it's a powerful and open-source One-Person web framework used to build enterprise-grade [Spring Boot](https://spring.io/projects/spring-boot/) applications with the powerfull [Groovy](https://groovy-lang.org/) programming language. The core framework is very extensible and there are numerous [Plugins](https://github.com/grace-plugins/) available that provide easy integration of add-on features. Getting Started --- -You need a Java Development Kit (JDK) installed, but it is not necessary to install Groovy because it's bundled with the Grails distribution. +You need a Java Development Kit (JDK) installed, but it is not necessary to install Groovy because it's bundled with the Grace distribution. -To install Grails, visit https://grails.org/download.html and download the version you would like to use. Set a `GRAILS_HOME` environment variable to point to the root of the extracted download and add `GRAILS_HOME/bin` to your executable `PATH`. Then in a shell, type the following: +To install Grace, visit https://github.com/graceframework/grace-framework/releases and download the version you would like to use. Set a `GRACE_HOME` environment variable to point to the root of the extracted download and add `GRACE_HOME/bin` to your executable `PATH`. Then in a shell, type the following: - grails create-app sampleapp - cd sampleapp - grails run-app +```bash +grace create-app com.example.blog +cd blog +grace run-app +``` -To build Grails, clone this GitHub repository and execute the install Gradle target: +To build Grace, clone this GitHub repository and execute the install Gradle target: - git clone https://github.com/grails/grails-core.git - cd grails-core - ./gradlew install +```bash +git clone https://github.com/graceframework/grace-framework.git +cd grace-framework +./gradlew pTML zipDist +``` If you encounter out of memory errors when trying to run the install target, try adjusting Gradle build settings. For example: - export GRADLE_OPTS="-Xmx2G -Xms2G -XX:NewSize=512m -XX:MaxNewSize=512m" +```bash +export GRADLE_OPTS="-Xmx2G -Xms2G -XX:NewSize=512m -XX:MaxNewSize=512m" +``` Performing a Release --- @@ -43,20 +38,4 @@ See [RELEASE.md](RELEASE.md). License --- -Grails and Groovy are licensed under the terms of the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). - -*** - -YourKit is kindly supporting Grails open source projects with its full-featured Java Profiler. -YourKit, LLC is the creator of innovative and intelligent tools for profiling -Java and .NET applications. Take a look at YourKit's leading software products: -[YourKit Java Profiler](https://www.yourkit.com/java/profiler/features/) and -[YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/features/). - -Dependencies ---- - -**Gradle Plugins** - -* SDKMAN! Vendor Plugin [Github](https://github.com/sdkman/sdkman-vendor-gradle-plugin). -* Gradle Nexus Staging Plugin [Github](https://github.com/Codearte/gradle-nexus-staging-plugin) +Grace is licensed under the terms of the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).