add 'How to use in Dev' to README
authorMichael Vorburger <mike@vorburger.ch>
Wed, 19 Dec 2018 16:24:23 +0000 (17:24 +0100)
committerMichael Vorburger <mike@vorburger.ch>
Wed, 1 Jul 2020 23:37:57 +0000 (01:37 +0200)
Signed-off-by: Michael Vorburger <mike@vorburger.ch>
README.md

index 722daa6f23e0ba1968ef2dc4a8de024604d98015..11afc604ff310636dfb6835e980f374894c1cdb3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,7 +14,13 @@ We do not anticipate this to become a new ODL (or external) project.
 
 This includes support for custom Karaf CLI Commands, based on the [ch.vorburger.karaf.simple](https://github.com/vorburger/ch.vorburger.karaf.simple) POC.
 
-## How to use
+## How to use in Dev
+
+ One of the main advantages of developing with opendaylight-simple is that you DO NOT NEED TO build a package on the CLI to start it, like we are used to in ODL with Karaf.  It's just simple standalone Java, so you just Run e.g. `GeniusMain` or `OpenFlowPluginWiringTest` & Co. directly in your favourite IDE!
+
+ The build (`maven-assembly-plugin`) is supringly slow, and you would typically only use it to package and run in production on a remote server.  Locally, in development, you do not have to leave your IDE anymore.  The running code is, of course, identical - there is no OSGi/Karaf runtime "container" anymore now.
+
+## How to use in Prod
 
     mvn -s .travis-maven-settings.xml clean package
     cd target/poc-1.0.0-SNAPSHOT-simple/poc-1.0.0-SNAPSHOT