jdaugherty commented on code in PR #14758: URL: https://github.com/apache/grails-core/pull/14758#discussion_r2100824803
########## README.md: ########## @@ -14,50 +14,102 @@ See the License for the specific language governing permissions and limitations under the License. --> -# Grails -[](https://ge.grails.org/scans) -[](https://github.com/apache/grails-core/actions/workflows/gradle.yml) +# Apache Grails (Incubating) + +[](https://docs.grails.org) +[](https://ge.grails.org/scans) +[](https://github.com/apache/grails-core/actions/workflows/gradle.yml) [](https://github.com/apache/grails-core/actions/workflows/groovy-joint-workflow.yml) +[](https://lists.apache.org/[email protected]) +[](https://slack.grails.org/) +[](https://github.com/apache/grails-core/discussions) + +## Introduction + +[Apache Grails](https://grails.org/) is a framework used to build web applications with +the [Apache Groovy](https://groovy-lang.org/) programming language. Releases prior to 7.0.0 were outside of the Apache +Software Foundation. The core framework is very extensible and there are numerous [plugins](https://plugins.grails.org/) +available that provide easy integration of add-on features. To assist in getting started, various Application generators +exist and are provided by the Apache Grails team. + +## Getting help + +Ask questions on the [Grails User Mailing List](https://lists.apache.org/[email protected]) +Join the discussions on [Slack](https://slack.grails.org/) +Check the [Documentation](https://docs.grails.org/) for your preferred Apache Grails version. +Check for a [Grails Guide](https://github.com/grails-guides/). + +## Application Generation + +The only requirement for Apache Grails is the Java Development Kit (JDK). Once a JDK is installed there are many ways to +get started. The preferred way to get started is to use [Grails Forge](https://start.grails.org). Alternatively, offline +CLI applications exist to assist in Application generation. Instructions for them follow. + +### Wrapper + +The Apache Grails Wrapper is a tiny distribution (25KB) that can manage larger sized CLIs for Grails. It consists of a +`grailsw` shell script, a `grailsw.bat` batch script, and the jar file `grails-wrapper.jar`. It can be downloaded from +the latest [Github Release](https://github.com/apache/grails-core/releases) page starting with 7.0.0-M4 & it is included +in any created project. The wrapper is used to either create an Apache Grails Application or to run commands in an +existing Grails Application directory. The wrapper is generally meant to be forward compatible and downloads the Apache +Grails CLIs to the directory `$HOME/.grails/wrapper`. + +#### Wrapper - Creating a Apache Grails Application + +To create an Apache Grails Application with the wrapper follow these steps: -### Getting help -Join the discussions on [Slack](https://slack.grails.org/) -Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/grails) +1. Extract the wrapper to your preferred location. +2. Set the environment variable `PREFERRED_GRAILS_VERSION` to the preferred version. +3. Run the wrapper command `grailsw -t forge create-app` to create a new Apache Grails Application. -## What is Grails? -[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. +Please note, that the wrapper supports either the legacy `Apache Grails Shell` or the newer `Apache Grails Forge` CLI. +For more detailed information about it, see the [documentation](https://docs.grails.org/snapshot/index.html). -[Commercial support](https://grails.org/support.html) options are available. Review Comment: @paulk-asert can you confirm this is ok since it will end up in the README source distribution? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
