Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

HHH-6207 Making the readme a github markdown readme

  • Loading branch information...
commit 83ef3ba3d692b4531dcd147bba85391e04c2cba3 1 parent e5da09c
@hferentschik hferentschik authored
Showing with 37 additions and 31 deletions.
  1. +0 −31 README
  2. +37 −0 README.md
View
31 README
@@ -1,31 +0,0 @@
-Starting with development of version 4.0, Hibernate uses Gradle (http://gradle.org) as its build tool. This README describes some of the basics developers and contributors new to Gradle need to know to get productive quickly. Here is a list of resources to obtain more detailed information about Gradle:
-
-* The Gradle User Guide : http://gradle.org/latest/docs/userguide/userguide_single.html
-* Gradle DSL Guide : http://gradle.org/latest/docs/dsl/index.html
-* Additional Hibernate/Gradle information : http://community.jboss.org/wiki/GradleFAQ
-
-Executing Tasks Across All Modules
-----------------------------------
-To execute a task across all modules, simply perform that task from the root directory. Gradle will visit each
-subproject and execute that task if the subproject defines it.
-
-Executing Tasks In Specific Module
-----------------------------------
-To execute a task in a specific module you can either:
-1. `cd` into that module directory and execute the task
-2. name the "task path". For example, in order to run the tests for the hibernate-core module from the root directory
- you could say `gradle hibernate-core:test`
-
-Common Java-module tasks
-------------------------
-* build - Assembles (jars) and tests this project
-* buildDependents - Assembles and tests this project and all projects that depend on it. So think of running this in hibernnate-entitymanager, Gradle would assemble and test hibernate-entitymanager as well as hibernate-envers (because envers depends on entitymanager)
-* classes - Compiles the main classes
-* testClasses - Compiles the test classes
-* jar - Generates a jar archive with all the compiled classes
-* test - Runs the tests
-* uploadArchives - Think Maven deploy
-* install - Installs the project jar to your local maven cache (aka ~/.m2/repository)
-* eclipse - Generates an Eclipse project
-* idea - Generates an IntelliJ/IDEA project.
-* clean - Cleans the build directory
View
37 README.md
@@ -0,0 +1,37 @@
+*Starting with development of version 4.0, Hibernate uses Gradle (http://gradle.org) as its build tool.*
+This README describes some of the basics developers and contributors new to Gradle need to know to get productive quickly.
+Here is a list of resources to obtain more detailed information about Gradle:
+
+* The Gradle User Guide : http://gradle.org/latest/docs/userguide/userguide_single.html
+* Gradle DSL Guide : http://gradle.org/latest/docs/dsl/index.html
+* Additional Hibernate/Gradle information : http://community.jboss.org/wiki/GradleFAQ
+
+Executing Tasks Across All Modules
+----------------------------------
+
+To execute a task across all modules, simply perform that task from the root directory. Gradle will visit each
+subproject and execute that task if the subproject defines it.
+
+
+Executing Tasks In Specific Module
+----------------------------------
+
+To execute a task in a specific module you can either:
+1. `cd` into that module directory and execute the task
+2. name the "task path". For example, in order to run the tests for the _hibernate-core_ module from the root directory you could say `gradle hibernate-core:test`
+
+
+Common Java-module tasks
+------------------------
+
+* _build_ - Assembles (jars) and tests this project
+* _buildDependents_ - Assembles and tests this project and all projects that depend on it. So think of running this in hibernnate-entitymanager, Gradle would assemble and test hibernate-entitymanager as well as hibernate-envers (because envers depends on entitymanager)
+* _classes_ - Compiles the main classes
+* _testClasses_ - Compiles the test classes
+* _jar_ - Generates a jar archive with all the compiled classes
+* _test_ - Runs the tests
+* _uploadArchives_ - Think Maven deploy
+* _install_ - Installs the project jar to your local maven cache (aka ~/.m2/repository)
+* _eclipse_ - Generates an Eclipse project
+* _idea_ - Generates an IntelliJ/IDEA project.
+* _clean_ - Cleans the build directory
Please sign in to comment.
Something went wrong with that request. Please try again.