From 8c1af2e7130a45bc6e96e442af3b552a3eac90fc Mon Sep 17 00:00:00 2001 From: Michael Yan Date: Tue, 12 Dec 2023 18:14:03 +0800 Subject: [PATCH] Grace: update README.md --- README.md | 47 ++++++-------------------- grace-api/README.md | 2 +- grace-bom/README.md | 2 +- grace-boot/README.md | 2 +- grace-bootstrap/README.md | 2 +- grace-cli/README.md | 2 +- grace-codecs/README.md | 2 +- grace-console/README.md | 2 +- grace-core/README.md | 2 +- grace-databinding/README.md | 2 +- grace-dependencies/README.md | 2 +- grace-docs/README.md | 2 +- grace-encoder/README.md | 2 +- grace-gradle-model/README.md | 2 +- grace-logging/README.md | 2 +- grace-plugin-api/README.md | 2 +- grace-plugin-codecs/README.md | 2 +- grace-plugin-controllers/README.md | 2 +- grace-plugin-converters/README.md | 2 +- grace-plugin-core/README.md | 2 +- grace-plugin-databinding/README.md | 2 +- grace-plugin-datasource/README.md | 2 +- grace-plugin-domain-class/README.md | 2 +- grace-plugin-i18n/README.md | 2 +- grace-plugin-interceptors/README.md | 2 +- grace-plugin-mimetypes/README.md | 2 +- grace-plugin-rest/README.md | 2 +- grace-plugin-services/README.md | 2 +- grace-plugin-url-mappings/README.md | 2 +- grace-plugin-validation/README.md | 2 +- grace-shell/README.md | 2 +- grace-spring-boot/README.md | 2 +- grace-spring/README.md | 2 +- grace-test-suite-base/README.md | 2 +- grace-test-suite-persistence/README.md | 2 +- grace-test-suite-uber/README.md | 2 +- grace-test-suite-web/README.md | 2 +- grace-test/README.md | 2 +- grace-util/README.md | 2 +- grace-web-boot/README.md | 2 +- grace-web-common/README.md | 2 +- grace-web-databinding/README.md | 2 +- grace-web-mvc/README.md | 2 +- grace-web-url-mappings/README.md | 2 +- grace-web/README.md | 2 +- 45 files changed, 54 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index 3b9fc5dbaa..aed4c835d0 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,23 @@ -[![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://graceframework.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.graceframework.org/) 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://graceframework.org/download.html 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 + grace create-app sampleapp cd sampleapp - grails run-app + 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 + git clone https://github.com/graceframework/grace-core.git + cd grace-core ./gradlew install If you encounter out of memory errors when trying to run the install target, try adjusting Gradle build settings. For example: @@ -43,20 +32,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). diff --git a/grace-api/README.md b/grace-api/README.md index 280f2bd746..478e7c6adf 100644 --- a/grace-api/README.md +++ b/grace-api/README.md @@ -1,3 +1,3 @@ -## grails-api +## grace-api This subproject contains much of the code for the Core API of Grails. diff --git a/grace-bom/README.md b/grace-bom/README.md index ebdc399780..cbff421f58 100644 --- a/grace-bom/README.md +++ b/grace-bom/README.md @@ -1,3 +1,3 @@ -## grails-bom +## grace-bom Build support for generating the Maven bill of materials. diff --git a/grace-boot/README.md b/grace-boot/README.md index f72575887b..89dbc61a0d 100644 --- a/grace-boot/README.md +++ b/grace-boot/README.md @@ -1,3 +1,3 @@ -## grails-boot +## grace-boot This subproject contains much of the code for the core of Grails support Spring Boot. diff --git a/grace-bootstrap/README.md b/grace-bootstrap/README.md index 197755604d..f68ebed4cb 100644 --- a/grace-bootstrap/README.md +++ b/grace-bootstrap/README.md @@ -1,3 +1,3 @@ -## grails-bootstrap +## grace-bootstrap This subproject contains much of the core code required to bootstrap the Grails environment. diff --git a/grace-cli/README.md b/grace-cli/README.md index c015961ca0..df46bd60da 100644 --- a/grace-cli/README.md +++ b/grace-cli/README.md @@ -1 +1 @@ -## grails-cli +## grace-cli diff --git a/grace-codecs/README.md b/grace-codecs/README.md index 88d2aedeae..badba952ca 100644 --- a/grace-codecs/README.md +++ b/grace-codecs/README.md @@ -1,3 +1,3 @@ -## grails-codecs +## grace-codecs Code related to Grails codec methods (`.encodeAsHTML)`, `.encodeAsHex()`, etc...) diff --git a/grace-console/README.md b/grace-console/README.md index 80b17b9103..79dd4b2407 100644 --- a/grace-console/README.md +++ b/grace-console/README.md @@ -1,3 +1,3 @@ -## grails-console +## grace-console This subproject contains code to support the Grails console, Grails shell and Grails Swing console. diff --git a/grace-core/README.md b/grace-core/README.md index 7bf8711806..c5488e4a42 100644 --- a/grace-core/README.md +++ b/grace-core/README.md @@ -1,3 +1,3 @@ -## grails-core +## grace-core This subproject contains much of the code for the core of Grails and common code referenced from many places in the project. diff --git a/grace-databinding/README.md b/grace-databinding/README.md index 07e734f1ed..3f74aead9e 100644 --- a/grace-databinding/README.md +++ b/grace-databinding/README.md @@ -1,4 +1,4 @@ -## grails-databinding +## grace-databinding This subproject contains much of the core data binding code. The main class here is [SimpleDataBinder](./src/main/groovy/grails/databinding/SimpleDataBinder.groovy). Most of the other code diff --git a/grace-dependencies/README.md b/grace-dependencies/README.md index cd2d52a9d5..ab7da503d5 100644 --- a/grace-dependencies/README.md +++ b/grace-dependencies/README.md @@ -1,2 +1,2 @@ -## grails-dependencies +## grace-dependencies diff --git a/grace-docs/README.md b/grace-docs/README.md index 8e42006cc7..7c16339c85 100644 --- a/grace-docs/README.md +++ b/grace-docs/README.md @@ -1,2 +1,2 @@ -## grails-docs +## grace-docs diff --git a/grace-encoder/README.md b/grace-encoder/README.md index 7a772b9f43..cf5fafe71e 100644 --- a/grace-encoder/README.md +++ b/grace-encoder/README.md @@ -1,2 +1,2 @@ -## grails-encoder +## grace-encoder diff --git a/grace-gradle-model/README.md b/grace-gradle-model/README.md index 4ac0ee46a5..aa945c9f6c 100644 --- a/grace-gradle-model/README.md +++ b/grace-gradle-model/README.md @@ -1,2 +1,2 @@ -## grails-gradle-model +## grace-gradle-model diff --git a/grace-logging/README.md b/grace-logging/README.md index 63a238f5fc..0740c145d9 100644 --- a/grace-logging/README.md +++ b/grace-logging/README.md @@ -1,3 +1,3 @@ -## grails-logging +## grace-logging This subproject adds a log property to all artefacts. Refer to http://grails.github.io/grails-doc/latest/ref/Plug-ins/logging.html \ No newline at end of file diff --git a/grace-plugin-api/README.md b/grace-plugin-api/README.md index fd2a3ebe9d..272742651d 100644 --- a/grace-plugin-api/README.md +++ b/grace-plugin-api/README.md @@ -1,2 +1,2 @@ -## grails-plugin-api +## grace-plugin-api diff --git a/grace-plugin-codecs/README.md b/grace-plugin-codecs/README.md index c4771bbbfa..15b56dc963 100644 --- a/grace-plugin-codecs/README.md +++ b/grace-plugin-codecs/README.md @@ -1,2 +1,2 @@ -## grails-plugin-codecs +## grace-plugin-codecs diff --git a/grace-plugin-controllers/README.md b/grace-plugin-controllers/README.md index bceac82e80..4524c9a2d5 100644 --- a/grace-plugin-controllers/README.md +++ b/grace-plugin-controllers/README.md @@ -1,2 +1,2 @@ -## grails-plugin-controllers +## grace-plugin-controllers diff --git a/grace-plugin-converters/README.md b/grace-plugin-converters/README.md index b7909bdc40..cd2048d207 100644 --- a/grace-plugin-converters/README.md +++ b/grace-plugin-converters/README.md @@ -1 +1 @@ -## grails-plugin-converters +## grace-plugin-converters diff --git a/grace-plugin-core/README.md b/grace-plugin-core/README.md index c955cfca3d..0848d55de9 100644 --- a/grace-plugin-core/README.md +++ b/grace-plugin-core/README.md @@ -1,2 +1,2 @@ -## grails-plugin-core +## grace-plugin-core diff --git a/grace-plugin-databinding/README.md b/grace-plugin-databinding/README.md index f7df623893..09e59405d6 100644 --- a/grace-plugin-databinding/README.md +++ b/grace-plugin-databinding/README.md @@ -1,2 +1,2 @@ -## grails-plugin-databinding +## grace-plugin-databinding diff --git a/grace-plugin-datasource/README.md b/grace-plugin-datasource/README.md index 8c1117be39..933a8f1b5e 100644 --- a/grace-plugin-datasource/README.md +++ b/grace-plugin-datasource/README.md @@ -1,2 +1,2 @@ -## grails-plugin-datasource +## grace-plugin-datasource diff --git a/grace-plugin-domain-class/README.md b/grace-plugin-domain-class/README.md index 9446bf393b..a69bbbad43 100644 --- a/grace-plugin-domain-class/README.md +++ b/grace-plugin-domain-class/README.md @@ -1,2 +1,2 @@ -## grails-plugin-domain-class +## grace-plugin-domain-class diff --git a/grace-plugin-i18n/README.md b/grace-plugin-i18n/README.md index 5c5875c42c..f329d28706 100644 --- a/grace-plugin-i18n/README.md +++ b/grace-plugin-i18n/README.md @@ -1,2 +1,2 @@ -## grails-plugin-i18n +## grace-plugin-i18n diff --git a/grace-plugin-interceptors/README.md b/grace-plugin-interceptors/README.md index a99833e8d6..79752de2c6 100644 --- a/grace-plugin-interceptors/README.md +++ b/grace-plugin-interceptors/README.md @@ -1,3 +1,3 @@ -## grails-plugin-interceptors +## grace-plugin-interceptors This subproject contains the code for the interceptors support. It contains the Interceptor trait and Matcher interface which are core to grails' Interceptor functionality. \ No newline at end of file diff --git a/grace-plugin-mimetypes/README.md b/grace-plugin-mimetypes/README.md index f0ff0de07c..0276d6b3a9 100644 --- a/grace-plugin-mimetypes/README.md +++ b/grace-plugin-mimetypes/README.md @@ -1,2 +1,2 @@ -## grails-plugin-mimetypes +## grace-plugin-mimetypes diff --git a/grace-plugin-rest/README.md b/grace-plugin-rest/README.md index 4ad832dcb8..d2442f96c1 100644 --- a/grace-plugin-rest/README.md +++ b/grace-plugin-rest/README.md @@ -1,2 +1,2 @@ -## grails-plugin-rest +## grace-plugin-rest diff --git a/grace-plugin-services/README.md b/grace-plugin-services/README.md index 09fe3400a9..734456f03f 100644 --- a/grace-plugin-services/README.md +++ b/grace-plugin-services/README.md @@ -1,2 +1,2 @@ -## grails-plugin-services +## grace-plugin-services diff --git a/grace-plugin-url-mappings/README.md b/grace-plugin-url-mappings/README.md index 26e3d7ac56..9876a58199 100644 --- a/grace-plugin-url-mappings/README.md +++ b/grace-plugin-url-mappings/README.md @@ -1,2 +1,2 @@ -## grails-plugin-url-mappings +## grace-plugin-url-mappings diff --git a/grace-plugin-validation/README.md b/grace-plugin-validation/README.md index d4de238b2d..1da274d766 100644 --- a/grace-plugin-validation/README.md +++ b/grace-plugin-validation/README.md @@ -1,2 +1,2 @@ -## grails-plugin-validation +## grace-plugin-validation diff --git a/grace-shell/README.md b/grace-shell/README.md index 4ecb23353d..95003cf42f 100644 --- a/grace-shell/README.md +++ b/grace-shell/README.md @@ -1,3 +1,3 @@ -## grails-shell +## grace-shell This subproject provides code related to the Grails CLI and plugin commands. diff --git a/grace-spring-boot/README.md b/grace-spring-boot/README.md index 0424dbd517..6d2915f34c 100644 --- a/grace-spring-boot/README.md +++ b/grace-spring-boot/README.md @@ -1,2 +1,2 @@ -## grails-spring-boot +## grace-spring-boot diff --git a/grace-spring/README.md b/grace-spring/README.md index 7606947886..94db8f4686 100644 --- a/grace-spring/README.md +++ b/grace-spring/README.md @@ -1,2 +1,2 @@ -## grails-spring +## grace-spring diff --git a/grace-test-suite-base/README.md b/grace-test-suite-base/README.md index 4752a3d25d..89cefc3f75 100644 --- a/grace-test-suite-base/README.md +++ b/grace-test-suite-base/README.md @@ -1,2 +1,2 @@ -## grails-test-suite-base +## grace-test-suite-base diff --git a/grace-test-suite-persistence/README.md b/grace-test-suite-persistence/README.md index 2420dedcd9..0a794ae822 100644 --- a/grace-test-suite-persistence/README.md +++ b/grace-test-suite-persistence/README.md @@ -1,2 +1,2 @@ -## grails-test-suite-persistence +## grace-test-suite-persistence diff --git a/grace-test-suite-uber/README.md b/grace-test-suite-uber/README.md index adf9a623c7..5d957fbbe8 100644 --- a/grace-test-suite-uber/README.md +++ b/grace-test-suite-uber/README.md @@ -1,2 +1,2 @@ -## grails-test-suite-uber +## grace-test-suite-uber diff --git a/grace-test-suite-web/README.md b/grace-test-suite-web/README.md index 6195eb7493..e650a16333 100644 --- a/grace-test-suite-web/README.md +++ b/grace-test-suite-web/README.md @@ -1,2 +1,2 @@ -## grails-test-suite-web +## grace-test-suite-web diff --git a/grace-test/README.md b/grace-test/README.md index 176ef9ffd7..b47cc05755 100644 --- a/grace-test/README.md +++ b/grace-test/README.md @@ -1,2 +1,2 @@ -## grails-test +## grace-test diff --git a/grace-util/README.md b/grace-util/README.md index 43168e56aa..b99d453341 100644 --- a/grace-util/README.md +++ b/grace-util/README.md @@ -1,3 +1,3 @@ -## grails-util +## grace-util Grails Utilities \ No newline at end of file diff --git a/grace-web-boot/README.md b/grace-web-boot/README.md index 24b5f69093..4303496e98 100644 --- a/grace-web-boot/README.md +++ b/grace-web-boot/README.md @@ -1,2 +1,2 @@ -## grails-web-boot +## grace-web-boot diff --git a/grace-web-common/README.md b/grace-web-common/README.md index 8ec7a6a1c6..fe250ed2d4 100644 --- a/grace-web-common/README.md +++ b/grace-web-common/README.md @@ -1,2 +1,2 @@ -## grails-web-common +## grace-web-common diff --git a/grace-web-databinding/README.md b/grace-web-databinding/README.md index 6f1f2d1972..16f36e4874 100644 --- a/grace-web-databinding/README.md +++ b/grace-web-databinding/README.md @@ -1,4 +1,4 @@ -## grails-web-databinding +## grace-web-databinding This subproject includes a lot of code to support data binding. diff --git a/grace-web-mvc/README.md b/grace-web-mvc/README.md index ae9482d752..cc2728eac3 100644 --- a/grace-web-mvc/README.md +++ b/grace-web-mvc/README.md @@ -1,2 +1,2 @@ -## grails-web-mvc +## grace-web-mvc diff --git a/grace-web-url-mappings/README.md b/grace-web-url-mappings/README.md index 7f9ec065cc..eb3a748ef3 100644 --- a/grace-web-url-mappings/README.md +++ b/grace-web-url-mappings/README.md @@ -1,2 +1,2 @@ -## grails-web-url-mappings +## grace-web-url-mappings diff --git a/grace-web/README.md b/grace-web/README.md index f134129995..c569c9c4f4 100644 --- a/grace-web/README.md +++ b/grace-web/README.md @@ -1,2 +1,2 @@ -## grails-web +## grace-web