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 2020/11/19 03:55:31 UTC

[incubator-nlpcraft-website] branch master updated: Update script.html

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-website.git


The following commit(s) were added to refs/heads/master by this push:
     new c8dd414  Update script.html
c8dd414 is described below

commit c8dd41459d55b933f0ff9bc0b25ae37b7631457e
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Wed Nov 18 19:49:43 2020 -0800

    Update script.html
---
 tools/script.html | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/tools/script.html b/tools/script.html
index 4af6376..d39b03d 100644
--- a/tools/script.html
+++ b/tools/script.html
@@ -24,15 +24,48 @@ id: script
 <div class="col-md-8 second-column">
     <section id="overview">
         <h2 class="section-title">Overview</h2>
+        <p>
+            <code>bin/nlpcraft.{sh|cmd}</code> script that is a <b>central management utility</b> for NLPCraft. Most
+            of the functions this script does can be done through running
+            Java applications - yet, using this script, you can accomplish the same things much simpler and quicker.
+            From starting and managing REST server, running various tools, to testing models via REST API -
+            <code>bin/nlpcraft.{sh|cmd}</code> script provides a single centralized utility that makes a quick work out
+            of all these routine tasks.
+        </p>
+        <p>
+            The script is only available in either official Apache <a href="/download.html#src">source ZIP</a> or in
+            <a href="/download.html#zip">binary ZIP</a> distributions. If you used Maven or similar build tools to
+            add NLPCraft to your project, this script will not available automatically - you will need to download ZIP
+            distribution separately.
+        </p>
+        <div class="bq warn">
+            <b>ZIP Distribution</b>
+            <p>
+                The <code>bin/nlpcraft.{sh|cmd}</code> script is only available in <a href="/download.html">ZIP distributions</a>. For Maven/Gradle/SBT
+                projects you will need to download <a href="/download.html">ZIP distribution</a> separately.
+            </p>
+        </div>
+        <p>
+            The script is located in <code>/bin</code> sub-folder of the installation root and is available for
+            Unix/Linux (<code>nlpcraft.sh</code>) and Windows (<code>nlpcraft.cmd</code>) environments. We will use
+            <code>.sh</code> version for the rest of instructions unless specified otherwise.
+        </p>
+    </section>
+    <section id="quick_start">
+        <h2 class="section-title">Quick Start</h2>
     </section>
     <section id="usage">
         <h2 class="section-title">Usage</h2>
+        <p>
+
+        </p>
     </section>
 </div>
 <div class="col-md-2 third-column">
     <ul class="side-nav">
         <li class="side-nav-title">On This Page</li>
         <li><a href="#overview">Overview</a></li>
+        <li><a href="#quick_start">Quick Start</a></li>
         <li><a href="#usage">Usage</a></li>
         {% include quick-links.html %}
     </ul>