Skip to content

Commit

Permalink
Update README.md with relevant links, move developer info to CONTRIBU…
Browse files Browse the repository at this point in the history
…TORS.md
  • Loading branch information
sambsnyd committed Aug 14, 2021
1 parent 0d5a41d commit 63ba619
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 28 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Building & Developing OpenRewrite

We use [Gradle](https://gradle.org/) to build this project.
The gradle wrapper checked into this project defines the gradle version to use.
When building from the command line invoke the wrapper with `./gradlew build` on unix-style terminals and `gradlew build` on windows-style terminals.

### CLI Environment Configuration:

* [JDK](https://adoptopenjdk.net/) version: 11
* JDK language & bytecode level: 1.8
* [Gradle](https://gradle.org/) version: Defined in wrapper
* [Kotlin](https://kotlinlang.org/) version: 1.5
* Kotlin language level: 1.5
* Kotlin JVM bytecode level: 1.8

### IDE Configuration

We use [IntelliJ IDEA](https://www.jetbrains.com/idea/) to develop this project.
Other IDEs or versions of this IDE can be made to work.
These are one set of versions we know works:

* IDEA version: 2021.1.3

You must set the `-parameters` compiler flag to run Rewrite tests.
If your system does not have UTF-8 as its default character encoding (e.g., Windows) you must also add `-encoding utf8`.
Add these to the "additional command line parameters" field in IntelliJ -> Preferences -> Build, Execution, Deployment -> Compiler -> Java Compiler.
35 changes: 7 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,14 @@
[![Apache 2.0](https://img.shields.io/github/license/openrewrite/rewrite.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![Maven Central](https://img.shields.io/maven-central/v/org.openrewrite/rewrite-java.svg)](https://mvnrepository.com/artifact/org.openrewrite/rewrite-java)

The Rewrite project is a mass refactoring ecosystem for Java and other source code, designed to eliminate technical debt across an engineering organization. It consists of a platform of prepackaged refactoring recipes for common framework migration and stylistic consistency tasks in Java, ready for you to apply in your build via Maven or Gradle plugins.
OpenRewrite project is a mass refactoring ecosystem for Java and other source code, designed to eliminate technical debt across an engineering organization.
This project delivers scalable automated code maintenance, best practices, vulnerability patching, API migrations, dependency management, and more.

Read the full documentation at [docs.openrewrite.org](https://docs.openrewrite.org/).
Start with our [quickstart guide](https://docs.openrewrite.org/getting-started/getting-started) and let OpenRewrite start handling the boring parts of software development for you. Full documentation available at [docs.openrewrite.org](https://docs.openrewrite.org/).

Feel free to join us on [Slack](https://join.slack.com/t/rewriteoss/shared_invite/zt-nj42n3ea-b~62rIHzb3Vo0E1APKCXEA)!
Feel free to join us on [Slack](https://join.slack.com/t/rewriteoss/shared_invite/zt-nj42n3ea-b~62rIHzb3Vo0E1APKCXEA)! We're happy to answer your questions directly.

## Building & Developing OpenRewrite
Follow us on [Twitter](https://twitter.com/moderneinc) and [LinkedIn](https://www.linkedin.com/company/moderneinc).

We use [Gradle](https://gradle.org/) to build this project.
The gradle wrapper checked into this project defines the gradle version to use.
When building from the command line invoke the wrapper with `./gradlew build` on unix-style terminals and `gradlew build` on windows-style terminals.

### CLI Environment Configuration:

* [JDK](https://adoptopenjdk.net/) version: 11
* JDK language & bytecode level: 1.8
* [Gradle](https://gradle.org/) version: Defined in wrapper
* [Kotlin](https://kotlinlang.org/) version: 1.5
* Kotlin language level: 1.5
* Kotlin JVM bytecode level: 1.8

### IDE Configuration

We use [IntelliJ IDEA](https://www.jetbrains.com/idea/) to develop this project.
Other IDEs or versions of this IDE can be made to work.
These are one set of versions we know works:

* IDEA version: 2021.1.3

You must set the `-parameters` compiler flag to run Rewrite tests.
If your system does not have UTF-8 as its default character encoding (e.g., Windows) you must also add `-encoding utf8`.
Add these to the "additional command line parameters" field in IntelliJ -> Preferences -> Build, Execution, Deployment -> Compiler -> Java Compiler.
This project is maintained by [Moderne](https://moderne.io/).
Visit us at https://moderne.io to learn how to remove the tedium, technical debt, and inefficiency from your organization's software development.

0 comments on commit 63ba619

Please sign in to comment.