Skip to content

Commit 53b3e7a

Browse files
committed
Update docs
1 parent ab5c646 commit 53b3e7a

File tree

5 files changed

+4
-4
lines changed

5 files changed

+4
-4
lines changed

docs-src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
InEngine.NET is a plugin-based software application that allows commands to be [queued](queuing), [scheduled](scheduling), and run directly.
1+
InEngine.NET is a plugin-based software application that allows [commands](commands) to be [queued](queuing), [scheduled](scheduling), and run directly.
22

33
## How does it work?
44

docs/commands/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -700,7 +700,7 @@ <h2 id="view-commands">View Commands<a class="headerlink" href="#view-commands"
700700
</pre></div>
701701

702702

703-
<p><img alt="InEngine Command List" src="../images/inengine.png" /></p>
703+
<p><img alt="InEngine Command List" src="../images/commands.png" /></p>
704704
<div class="admonition note">
705705
<p class="admonition-title">InEngine.Core is a Plugin</p>
706706
<p>The <strong>InEngine.Core</strong> library is itself a plugin that contains queueing, scheduling, and other commands. </p>

docs/images/inegine.png

-587 KB
Binary file not shown.

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@
469469

470470
<h1>Quickstart</h1>
471471

472-
<p>InEngine.NET is a plugin-based software application that allows commands to be <a href="./queuing">queued</a>, <a href="./scheduling">scheduled</a>, and run directly.</p>
472+
<p>InEngine.NET is a plugin-based software application that allows <a href="./commands">commands</a> to be <a href="./queuing">queued</a>, <a href="./scheduling">scheduled</a>, and run directly.</p>
473473
<h2 id="how-does-it-work">How does it work?<a class="headerlink" href="#how-does-it-work" title="Permanent link">&para;</a></h2>
474474
<p>InEngine.NET uses a plugin system to dynamically load .NET assemblies and execute code.
475475
It also has a built-in command for launching external non-.NET programs.</p>

docs/search/search_index.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"docs": [
33
{
44
"location": "/",
5-
"text": "InEngine.NET is a plugin-based software application that allows commands to be \nqueued\n, \nscheduled\n, and run directly.\n\n\nHow does it work?\n\n\nInEngine.NET uses a plugin system to dynamically load .NET assemblies and execute code. \nIt also has a built-in command for launching external non-.NET programs.\n\n\nGet started by pulling the binaries from the \nlatest release\n on GitHub.\n\n\nThen run a command the \necho\n command from the core plugin:\n\n\ninengine.exe \necho\n --text\nHello, world\n\n\n\n\n\n\nOr if you're a Linux or Mac OS X fan (like me!), use the \ninengine\n shell script (\nMono\n is required):\n\n\ninengine \necho\n --text\nHello, world\n\n\n\n\n\n\nInstead of downloading binaries and runtimes, you can pull the latest Docker image:\n\n\ndocker pull ethanhann/inengine:latest\n\n\n\n\n\nNow run a command in a container:\n\n\ndocker run --rm inengine \necho\n --text\nHello, world\n\n\n\n\n\n\nHow does queueing work?\n\n\nThere are a lot of \nqueuing\n features, but this is the gist...\n\n\nWant to queue our example echo command to run in the background or possibly on another server?\n\n\nUse the core plugin's \nqueue:publish\n command:\n\n\ninengine.exe queue:publish --command-plugin\n=\nInEngine.Core --command-verb\n=\necho\n --args \ntext=Hello, world\n\n\n\n\n\n\nHow do we consume that queued echo command?\n\n\nUse the core plugin's \nqueue:consume\n command of course:\n\n\ninengine.exe queue:consume\n\n\n\n\n\nHow do I run non-.NET commands?\n\n\nThere is a special \nproc\n command in the core plugin that allows for the execution of any program you can run at the command line. \n\n\nFor example, create a python script called \nhelloworld.py\n that contains this:\n\n\nprint\n \nHello, world!\n\n\n\n\n\n\nNow execute it with the \nproc\n command:\n\n\ninengine proc --command\n=\n/usr/bin/python --args\n=\nhelloworld.py",
5+
"text": "InEngine.NET is a plugin-based software application that allows \ncommands\n to be \nqueued\n, \nscheduled\n, and run directly.\n\n\nHow does it work?\n\n\nInEngine.NET uses a plugin system to dynamically load .NET assemblies and execute code. \nIt also has a built-in command for launching external non-.NET programs.\n\n\nGet started by pulling the binaries from the \nlatest release\n on GitHub.\n\n\nThen run a command the \necho\n command from the core plugin:\n\n\ninengine.exe \necho\n --text\nHello, world\n\n\n\n\n\n\nOr if you're a Linux or Mac OS X fan (like me!), use the \ninengine\n shell script (\nMono\n is required):\n\n\ninengine \necho\n --text\nHello, world\n\n\n\n\n\n\nInstead of downloading binaries and runtimes, you can pull the latest Docker image:\n\n\ndocker pull ethanhann/inengine:latest\n\n\n\n\n\nNow run a command in a container:\n\n\ndocker run --rm inengine \necho\n --text\nHello, world\n\n\n\n\n\n\nHow does queueing work?\n\n\nThere are a lot of \nqueuing\n features, but this is the gist...\n\n\nWant to queue our example echo command to run in the background or possibly on another server?\n\n\nUse the core plugin's \nqueue:publish\n command:\n\n\ninengine.exe queue:publish --command-plugin\n=\nInEngine.Core --command-verb\n=\necho\n --args \ntext=Hello, world\n\n\n\n\n\n\nHow do we consume that queued echo command?\n\n\nUse the core plugin's \nqueue:consume\n command of course:\n\n\ninengine.exe queue:consume\n\n\n\n\n\nHow do I run non-.NET commands?\n\n\nThere is a special \nproc\n command in the core plugin that allows for the execution of any program you can run at the command line. \n\n\nFor example, create a python script called \nhelloworld.py\n that contains this:\n\n\nprint\n \nHello, world!\n\n\n\n\n\n\nNow execute it with the \nproc\n command:\n\n\ninengine proc --command\n=\n/usr/bin/python --args\n=\nhelloworld.py",
66
"title": "Quickstart"
77
},
88
{

0 commit comments

Comments
 (0)