You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nlpcraft.apache.org by ar...@apache.org on 2021/01/12 04:33:12 UTC
[incubator-nlpcraft] branch master updated: Update README.md
This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/master by this push:
new eeb278e Update README.md
eeb278e is described below
commit eeb278e8e70fcbcec620f2555722dd1f5831b505
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Mon Jan 11 20:33:00 2021 -0800
Update README.md
---
.../org/apache/nlpcraft/examples/alarm/README.md | 24 +++-------------------
1 file changed, 3 insertions(+), 21 deletions(-)
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 032c8c5..19f6df3 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
@@ -23,32 +23,14 @@
[![Documentation Status](https://img.shields.io/:docs-latest-green.svg)](https://nlpcraft.apache.org/docs.html)
[![Gitter](https://badges.gitter.im/apache-nlpcraft/community.svg)](https://gitter.im/apache-nlpcraft/community)
-### Alarm Example
+### Alarm Clock Example
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 timer is up it will simply print out "BEEP BEEP BEEP" in the probe console.
-
-### Running
-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="org.apache.nlpcraft.examples.alarm.AlarmModel"`
- * **Program arguments:** `-probe`
+When the timer is up, it will simply print out "BEEP BEEP BEEP" in the probe console.
### Documentation
-See [Getting Started](https://nlpcraft.apache.org/getting-started.html) guide for more instructions on how to run these examples.
+See [Alarm Clock](https://nlpcraft.apache.org/examples/alarm_clock.html) guide for more instructions on how to run this example.
For any questions, feedback or suggestions: