Update readme files

Arpic · Nov 6, 2019 · 3515225 · 3515225
1 parent 5f90430
commit 3515225
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,70 @@
 
 The SLIMS API allows you to write SLIMSGATE plugins and SLIMS Vaadin plugins. 
 
-Visit [templates](templates/) to look for empty example plugins.
+## Prerequisites.
+
+As a prerequisite you will need to have an account on Genohm's build infrastructure. 
+Please contact your SLIMS project lead to get access. 
+They will send you a gradle.properties file looking like this:
+
+```
+slimsApiArtifactoryUser=<your user on genohms artifactory>
+slimsApiArtifactoryPassword=<your password on genohms artifactory>
+slimsApiArtifactoryRepository=<genohms artifact>
+
+
+slimsRestApiUser=<a user on your installed slims>
+slimsRestApiPassword=<the password for that user>
+slimsRestApiEndpoint=<the url to the installed slimsrest>
+```
+
+You will need to place this file in 
+
+```
+~/.gradle/gradle.properties
+```
+
+## Using gradle
+
+### Setup
+
+Once your account is setup, download this repository and navigate to the base folder of the repository with the command line interface you use. 
+We suggest using GIT Bash for Windows. 
+Build the projects for your favorite IDE (Eclipse or IntelliJ) with:
 
-The examples here can be used to get some insight into how you could write your own plugin. To build your own plugins you will need access to our api classes. Please contact your SLIMS project lead to get access. 
+```
+# Eclipse
+./gradlew eclipse
+# IntelliJ
+./gradlew idea
+```
 
+Now the plugin projects can be imported in your IDE.
+Repeat this command for every new plugin project or dependency change.
+Newly defined plugin projects should also be included in [settings.gradle](settings.gradle).
+
+### Usage
+
+Next try to create a dummy project. 
+We suggest starting with slimsgate-template.
+You can test out if you can build your individual plugin with:
+
+```
+./gradlew templates:slimsgate-template:fatjar
+```
+
+Alternatively you can also build all your plugins at once with:
+
+```
+./gradlew fatjar
+```
+
+You can upload and deploy your plugin with:
+
+```
+./gradlew templates:slimsgate-template:uploadToSlims
+```
+
+## Example templates
+
+Visit [templates](templates/) to look for empty example plugins.
diff --git a/templates/README.md b/templates/README.md
@@ -8,43 +8,4 @@ There are some empty template projects listed here. They provide you with an emp
 
  * dto-template: An empty DTO project. Can be used to put DTO objects in to transfer in between SLIMS and SLIMS GATE
 
- * library-template: An empty library project. Can be used to put common code into.
-
-## Prerequisites.
-
-As a prerequisite you will need to have an account on Genohm's build infrastructure. They will send you a gradle.properties file looking like this.
-
-```
-slimsApiArtifactoryUser=<your user on genohms artifactory>
-slimsApiArtifactoryPassword=<your password on genohms artifactory>
-slimsApiArtifactoryRepository=<genohms artifact>
-
-
-slimsRestApiUser=<a user on your installed slims>
-slimsRestApiPassword=<the password for that user>
-slimsRestApiEndpoint=<the url to the installed slimsrest>
-```
-
-You will need to place this file in 
-
-```
-~/.gradle/gradle.properties
-```
-
-## Using gradle
-
-Once you are setup, download this repository and try to create a dummy project. We suggest starting with slimsgate-template. 
-
-Navigate to the base folder of the repository with the command line interface you use. We suggest using GIT Bash for Windows. You can test out if you can build your plugin with
-
-```
-./gradlew templates:slimsgate-template:fatjar
-```
-
-You can upload and deploy your plugin with
-
-```
-./gradlew templates:slimsgate-template:uploadToSlims
-```
-
-Make sure that new defined projects are included in [settings.gradle](../settings.gradle).
+ * library-template: An empty library project. Can be used to put common code into.