Skip to content

Commit

Permalink
Grace: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rainboyan committed Dec 12, 2023
1 parent a90d7ed commit 8c1af2e
Show file tree
Hide file tree
Showing 45 changed files with 54 additions and 81 deletions.
47 changes: 10 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]> 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:
Expand All @@ -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).
2 changes: 1 addition & 1 deletion grace-api/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-api
## grace-api

This subproject contains much of the code for the Core API of Grails.
2 changes: 1 addition & 1 deletion grace-bom/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-bom
## grace-bom

Build support for generating the Maven bill of materials.
2 changes: 1 addition & 1 deletion grace-boot/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-boot
## grace-boot

This subproject contains much of the code for the core of Grails support Spring Boot.
2 changes: 1 addition & 1 deletion grace-bootstrap/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-bootstrap
## grace-bootstrap

This subproject contains much of the core code required to bootstrap the Grails environment.
2 changes: 1 addition & 1 deletion grace-cli/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
## grails-cli
## grace-cli
2 changes: 1 addition & 1 deletion grace-codecs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-codecs
## grace-codecs

Code related to Grails codec methods (`.encodeAsHTML)`, `.encodeAsHex()`, etc...)
2 changes: 1 addition & 1 deletion grace-console/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-console
## grace-console

This subproject contains code to support the Grails console, Grails shell and Grails Swing console.
2 changes: 1 addition & 1 deletion grace-core/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion grace-databinding/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion grace-dependencies/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-dependencies
## grace-dependencies

2 changes: 1 addition & 1 deletion grace-docs/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-docs
## grace-docs

2 changes: 1 addition & 1 deletion grace-encoder/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-encoder
## grace-encoder

2 changes: 1 addition & 1 deletion grace-gradle-model/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-gradle-model
## grace-gradle-model

2 changes: 1 addition & 1 deletion grace-logging/README.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion grace-plugin-api/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-api
## grace-plugin-api

2 changes: 1 addition & 1 deletion grace-plugin-codecs/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-codecs
## grace-plugin-codecs

2 changes: 1 addition & 1 deletion grace-plugin-controllers/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-controllers
## grace-plugin-controllers

2 changes: 1 addition & 1 deletion grace-plugin-converters/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
## grails-plugin-converters
## grace-plugin-converters
2 changes: 1 addition & 1 deletion grace-plugin-core/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-core
## grace-plugin-core

2 changes: 1 addition & 1 deletion grace-plugin-databinding/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-databinding
## grace-plugin-databinding

2 changes: 1 addition & 1 deletion grace-plugin-datasource/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-datasource
## grace-plugin-datasource

2 changes: 1 addition & 1 deletion grace-plugin-domain-class/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-domain-class
## grace-plugin-domain-class

2 changes: 1 addition & 1 deletion grace-plugin-i18n/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-i18n
## grace-plugin-i18n

2 changes: 1 addition & 1 deletion grace-plugin-interceptors/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion grace-plugin-mimetypes/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-mimetypes
## grace-plugin-mimetypes

2 changes: 1 addition & 1 deletion grace-plugin-rest/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-rest
## grace-plugin-rest

2 changes: 1 addition & 1 deletion grace-plugin-services/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-services
## grace-plugin-services

2 changes: 1 addition & 1 deletion grace-plugin-url-mappings/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-url-mappings
## grace-plugin-url-mappings

2 changes: 1 addition & 1 deletion grace-plugin-validation/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-plugin-validation
## grace-plugin-validation

2 changes: 1 addition & 1 deletion grace-shell/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-shell
## grace-shell

This subproject provides code related to the Grails CLI and plugin commands.
2 changes: 1 addition & 1 deletion grace-spring-boot/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-spring-boot
## grace-spring-boot

2 changes: 1 addition & 1 deletion grace-spring/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-spring
## grace-spring

2 changes: 1 addition & 1 deletion grace-test-suite-base/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-test-suite-base
## grace-test-suite-base

2 changes: 1 addition & 1 deletion grace-test-suite-persistence/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-test-suite-persistence
## grace-test-suite-persistence

2 changes: 1 addition & 1 deletion grace-test-suite-uber/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-test-suite-uber
## grace-test-suite-uber

2 changes: 1 addition & 1 deletion grace-test-suite-web/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-test-suite-web
## grace-test-suite-web

2 changes: 1 addition & 1 deletion grace-test/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-test
## grace-test

2 changes: 1 addition & 1 deletion grace-util/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## grails-util
## grace-util

Grails Utilities
2 changes: 1 addition & 1 deletion grace-web-boot/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-web-boot
## grace-web-boot

2 changes: 1 addition & 1 deletion grace-web-common/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-web-common
## grace-web-common

2 changes: 1 addition & 1 deletion grace-web-databinding/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## grails-web-databinding
## grace-web-databinding

This subproject includes a lot of code to support data binding.

Expand Down
2 changes: 1 addition & 1 deletion grace-web-mvc/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-web-mvc
## grace-web-mvc

2 changes: 1 addition & 1 deletion grace-web-url-mappings/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-web-url-mappings
## grace-web-url-mappings

2 changes: 1 addition & 1 deletion grace-web/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## grails-web
## grace-web

0 comments on commit 8c1af2e

Please sign in to comment.