This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch NLPCRAFT-41
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/NLPCRAFT-41 by this push:
new d0209b3 WIP on readme.md
d0209b3 is described below
commit d0209b38d5cebf1b3d7b2e7ba6388741be26cd2b
Author: Aaron Radzinski <[email protected]>
AuthorDate: Wed Aug 19 18:24:54 2020 -0700
WIP on readme.md
---
README.md | 1 -
.../scala/org/apache/nlpcraft/examples/alarm/README.md | 18 ++++++++++--------
2 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 4db53de..292f167 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,6 @@ lock-in:
## Other Projects
- [Apache NLPCraft Java
Client](https://github.com/apache/incubator-nlpcraft-java-client) - Native Java
client for NLPCraft REST API.
-- [Apache NLPCraft UI](https://github.com/apache/incubator-nlpcraft-ui) - Web
UI for testing and debugging.
### Copyright
Copyright (C) 2020 Apache Software Foundation
diff --git
a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
index e09f0df..33afcf6 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/examples/alarm/README.md
@@ -27,31 +27,33 @@
This example provides a simple "alarm clock" interface where you can ask to
set the timer for a
specific duration from now expressed in hours, minutes and/or seconds. You can
say
`ping me in 3 minutes`, `buzz me in an hour and 15 minutes`, or `set my alarm
for 30 secs`.
-When the timers is up it will simply print out "BEEP BEEP BEEP" in the probe
console.
+When the timer is up it will simply print out "BEEP BEEP BEEP" in the probe
console.
### Running
-You can run necessary JVMs for this example similarly from command line or IDE.
-NOTE: that you don't need to start Data Probe standalone if you are only
running the unit test as it uses the
+You can run necessary JVMs for this example the same way from either the
command line or IDE.
+Note that you don't need to start Data Probe standalone if you are only
running the unit test as it uses the
embedded probe and starts it automatically:
* Run REST server:
* **Main class:** `org.apache.nlpcraft.NCStart`
* **Program arguments:** `-server`
+ * Test using built-in model auto-validator:
+ * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
+ * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel`
+
+If not using built-in test framework (i.e. not using embedded probe) you need
to start data probe manually:
* Run probe standalone and use your own [REST
client](https://nlpcraft.apache.org/using-rest.html):
* **Main class:** `org.apache.nlpcraft.NCStart`
* **VM arguments:** `-Dconfig.override_with_env_vars=true`
* **Environment variables:**
`CONFIG_FORCE_nlpcraft_probe_models.0=org.apache.nlpcraft.examples.alarm.AlarmModel`
* **Program arguments:** `-probe`
- * Test using built-in test framework:
- * **Main class:**
`org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator`
- * **VM arguments:**
`-DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.alarm.AlarmModel`
-
+
### Documentation
See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide
for more instructions on how to run these examples.
For any questions, feedback or suggestions:
* View & run other
[examples](https://github.com/apache/incubator-nlpcraft/tree/master/nlpcraft/src/main/scala/org/apache/nlpcraft/examples)
- * Latest [Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and
[REST APIs](https://nlpcraft.apache.org/using-rest.html)
+ * Read [documentation](https://nlpcraft.apache.org/docs.html), latest
[Javadoc](http://nlpcraft.apache.org/apis/latest/index.html) and [REST
APIs](https://nlpcraft.apache.org/using-rest.html)
* Download & Maven/Grape/Gradle/SBT
[instructions](https://nlpcraft.apache.org/download.html)
* File a bug or improvement in
[JIRA](https://issues.apache.org/jira/projects/NLPCRAFT)
* Post a question at [Stack
Overflow](https://stackoverflow.com/questions/ask) using <code>nlpcraft</code>
tag
