Skip to content

Commit 76c9e94

Browse files
committed
Update docs
1 parent 9180d2e commit 76c9e94

File tree

5 files changed

+109
-60
lines changed

5 files changed

+109
-60
lines changed

docs-src/commands.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ They can be C# classes, lambda expressions, or CLI programs.
88
The InEngine.Core package is required to create a C# class command.
99
Install it in a Visual Studio project.
1010

11-
==Package Manager==
11+
**Package Manager**
1212
```bash
1313
Install-Package InEngine.Core
1414
```
1515

16-
==Nuget CLI==
16+
**Nuget CLI**
1717
```bash
1818
nuget install InEgine.Core
1919
```
2020

21-
==.NET CLI==
21+
**.NET CLI**
2222
```bash
2323
dotnet add package InEngine.Core
2424
```
2525

26-
==Paket CLI==
26+
**Paket CLI**
2727
```bash
2828
paket add InEngine.Core
2929
```
3030

31-
Adding a class that implements ==InEngine.Core.ICommand== is the simplest way to create a command.
31+
Adding a class that implements **InEngine.Core.ICommand** is the simplest way to create a command.
3232

3333
```c#
3434
using System;
@@ -47,7 +47,7 @@ namespace MyCommandPlugin
4747
```
4848

4949
A command that implements ICommand can be run directly or [queued](queuing), but it cannot be [scheduled](scheduling).
50-
Extending the ==InEngine.Core.AbstractCommand== class adds extra functionality, like a progress bar, and the ability to schedule the command using the scheduler.
50+
Extending the **InEngine.Core.AbstractCommand** class adds extra functionality, like a progress bar, and the ability to schedule the command using the scheduler.
5151
Minimally, the Run method should be overridden.
5252

5353
```c#
@@ -68,7 +68,7 @@ namespace MyCommandPlugin
6868

6969
## Run a Command
7070

71-
Create a class that implements ==InEngine.Core.IOptions== in the same assembly as the command class.
71+
Create a class that implements **InEngine.Core.IOptions** in the same assembly as the command class.
7272
Add a VerbOptions attribute, from the CommandLine namespace, that defines the name of the command.
7373
Optional help text can also be specified in the VerbOption attribute.
7474
The help text can be auto-generated from the attribute or manually specified in the GetUsage method if desired.
@@ -108,7 +108,7 @@ inengine.exe -pMyCommandPlugin my-command
108108
### Executing Arbitrary Processes
109109

110110
It isn't necessary to create C# classes to utilize InEngine.NET.
111-
Arbitrary commands can be run, with an argument list by leveraging the InEngine.Core plugin's ==proc== command.
111+
Arbitrary commands can be run, with an argument list by leveraging the InEngine.Core plugin's **proc** command.
112112
The command lists directory contents using "ls" with the "-lhp" switches:
113113

114114
```bash
@@ -151,7 +151,7 @@ Run inengine.exe with only the plugin specified:
151151
inengine.exe -pInEngine.Core
152152
```
153153

154-
The ==InEngine.Core== library is itself a plugin that contains queue-related and other commands.
154+
The **InEngine.Core** library is itself a plugin that contains queue-related and other commands.
155155
As an example, this is the help output for the core plugin.
156156

157157
```text
@@ -186,7 +186,7 @@ Run the command with the -h or --help arguments.
186186
inengine.exe -pInEngine.Core queue:publish -h
187187
```
188188

189-
The ==InEngine.Core== plugin's command to clear the InEngine.NET queues produces this help message.
189+
The **InEngine.Core** plugin's command to clear the InEngine.NET queues produces this help message.
190190

191191
```text
192192
InEngine 3.x
@@ -210,7 +210,7 @@ Copyright © 2017 Ethan Hann
210210

211211
## Writing Output
212212

213-
The ==InEngine.Core.AbstractCommand== class provides some helper functions to output text to the console, for example:
213+
The **InEngine.Core.AbstractCommand** class provides some helper functions to output text to the console, for example:
214214

215215
```c#
216216
public override void Run()
@@ -278,7 +278,7 @@ The [NLog configuration](https://github.com/NLog/NLog/wiki/Tutorial#configuratio
278278

279279
## Progress Bar
280280

281-
The ==InEngine.Core.AbstractCommand== class provides a ProgressBar property to show command progress in a terminal.
281+
The **InEngine.Core.AbstractCommand** class provides a ProgressBar property to show command progress in a terminal.
282282
This is how it is used:
283283

284284
```c#

docs-src/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Configuration
22

33
Configuration is accomplished by modifying the appsettings.json file that comes with the InEngine.NET binary distribution.
4-
The ==-c, --configuration== argument can also be used to specify an alternate configuration file.
4+
The **-c, --configuration** argument can also be used to specify an alternate configuration file.
55

66

77
```json

docs-src/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ It also has a built-in command for launching external non-.NET programs.
77

88
Get started by pulling the binaries from the [latest release](https://github.com/InEngine-NET/InEngine.NET/releases) on GitHub.
99

10-
Then run a command the ==echo== command from the core plugin:
10+
Then run a command the **echo** command from the core plugin:
1111

1212
```bash
1313
inengine.exe -pInEngine.Core echo --text"Hello, world"
1414
```
15-
Or if you're a Linux or Mac OS X fan (like me!), use the ==inengine== shell script ([Mono](http://www.mono-project.com/download/) is required):
15+
Or if you're a Linux or Mac OS X fan (like me!), use the **inengine** shell script ([Mono](http://www.mono-project.com/download/) is required):
1616

1717
```bash
1818
inengine -pInEngine.Core echo --text"Hello, world"
@@ -36,31 +36,31 @@ There are a lot of [queuing](queuing) features, but this is the gist...
3636

3737
Want to queue our example echo command to run in the background or possibly on another server?
3838

39-
Use the core plugin's ==queue:publish== command:
39+
Use the core plugin's **queue:publish** command:
4040

4141
```bash
4242
inengine.exe -pInEngine.Core queue:publish --command-plugin=InEngine.Core.dll --command-verb=echo --args "text=Hello, world"
4343
```
4444

4545
How do we consume that queued echo command?
4646

47-
Use the core plugin's ==queue:consume== command of course:
47+
Use the core plugin's **queue:consume** command of course:
4848

4949
```bash
5050
inengine.exe -pInEngine.Core queue:consume
5151
```
5252

5353
## How do I run non-.NET commands?
5454

55-
There is a special ==proc== command in the core plugin that allows for the execution of any program you can run at the command line.
55+
There is a special **proc** command in the core plugin that allows for the execution of any program you can run at the command line.
5656

57-
For example, create a python script called ==helloworld.py== that contains this:
57+
For example, create a python script called **helloworld.py** that contains this:
5858

5959
```python
6060
print 'Hello, world!'
6161
```
6262

63-
Now execute it with the ==proc== command:
63+
Now execute it with the **proc** command:
6464

6565
```bash
6666
inengine -pInEngine.Core proc --command=/usr/bin/python --args=helloworld.py

docs-src/queuing.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This driver can be useful for plugin development and testing.
4343

4444
### With C# Classes
4545

46-
[Commands](commands) can be published programmatically with the ==InEngine.Core.Queuing.Queue== class:
46+
[Commands](commands) can be published programmatically with the **InEngine.Core.Queuing.Queue** class:
4747

4848
```c#
4949
Queue.Make().Publish(new MyCommand());
@@ -63,7 +63,7 @@ Queue.Make(true).Publish(new MyCommand());
6363
### With Lambda Expressions
6464

6565
Lambda expressions, aka anonymous functions, can be queued.
66-
The disadvantage to queuing lambdas is that the helpful functionality available in ==InEngine.Core.AbstractCommand== is not available.
66+
The disadvantage to queuing lambdas is that the helpful functionality available in **InEngine.Core.AbstractCommand** is not available.
6767

6868
This is how you queue a lambda:
6969

@@ -108,7 +108,7 @@ Subject.Publish(new List<AbstractCommand>() {
108108
### From the Command Line
109109

110110
Commands can be published from the command line as well.
111-
Note that all queue commands reside in the ==InEngine.Core== plugin.
111+
Note that all queue commands reside in the **InEngine.Core** plugin.
112112
This is an example of how to publish a command from the CLI by specifying the command's plugin, class name, and arguments:
113113

114114
```bash
@@ -151,7 +151,7 @@ Commands can be consumed from the command line as well with this simple command:
151151
inengine.exe -pInEngine.Core queue:consume
152152
```
153153

154-
Use the ==--secondary== argument to consume the secondary queue instead of the primary queue:
154+
Use the **--secondary** argument to consume the secondary queue instead of the primary queue:
155155

156156
```bash
157157
inengine.exe -pInEngine.Core queue:consume --secondary
@@ -166,15 +166,15 @@ There are a variety of [ways to run the scheduler](scheduling/#running-the-sched
166166

167167
### Viewing Queue Lengths
168168

169-
The ==queue:length== command shows a quick summary of pending, in-progress, and failed commands in the primary and secondary queues:
169+
The **queue:length** command shows a quick summary of pending, in-progress, and failed commands in the primary and secondary queues:
170170

171171
```bash
172172
inengine.exe -pInEngine.Core queue:length
173173
```
174174

175175
### Peek at Queued Commands
176176

177-
The ==queue:peek== command allows for queued commands to be inspected:
177+
The **queue:peek** command allows for queued commands to be inspected:
178178

179179
```bash
180180
inengine.exe -pInEngine.Core queue:peek --pending --in-progress --failed
@@ -208,7 +208,7 @@ inengine.exe -pInEngine.Core queue:peek --pending --from=100 --to=200
208208
## Handling Failed Commands
209209

210210
Commands that throw an exception are put in a special "failed" queue.
211-
They can be republished with the ==queue:republish== command:
211+
They can be republished with the **queue:republish** command:
212212

213213
```bash
214214
inengine.exe -pInEngine.Core queue:republish

0 commit comments

Comments
 (0)