Skip to content

Commit e2ef6f1

Browse files
committed
Add some getting started docs
1 parent b7c50d7 commit e2ef6f1

File tree

2 files changed

+37
-4
lines changed

2 files changed

+37
-4
lines changed

docs-src/index.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
1-
InEngine.NET allows commands to be queued, scheduled, and run directly.
1+
InEngine.NET allows commands to be queued, scheduled, and run directly.
2+
3+
## How does it work?
4+
5+
InEngine.NET uses a plugin system to dynamically load .NET assemblies and execute code.
6+
It also has a built-in command for launching external non-.NET programs.
7+
8+
Get started by pulling the latest binaries from the [latest release](https://github.com/InEngine-NET/InEngine.NET/releases) on GitHub.
9+
10+
Then run a [command](commands):
11+
12+
```bash
13+
inengine.exe -pInEngine.Core echo --text"Hello, world"
14+
```
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/) required.):
16+
17+
```bash
18+
# or if you\'re a Linux fan like me...
19+
20+
inengine -pInEngine.Core echo --text"Hello, world"
21+
```
22+
23+
Instead of downloading binaries and runtimes, you can pull the latest Docker image:
24+
25+
```bash
26+
docker pull ethanhann/inengine:latest
27+
```
28+
29+
Now run a command in a container:
30+
31+
```bash
32+
docker run --rm inengine -pInEngine.Core echo --text"Hello, world"
33+
```
34+
35+
You can get started with either the
36+
Get started by reading up on [commands](commands), then [scheduling](scheduling) and [queuing](queuing).
237

3-
Get started by reading up on [commands](commands), then [scheduling](scheduling) and [queuing](queuing).

docs-src/scheduling.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Scheduling
22

3-
[Commands](commands) can be scheduled to run by leveraging the inengine.exe program, available as a download from a recent [release](https://github.com/InEngine-NET/InEngine.NET/releases).
3+
[Commands](commands) can be run at certain times on recurring schedules.
44

55
## Scheduling a Command
66

77
A job schedule is created by adding a class to your plugin assembly that implements the **InEngine.Core.IJobs** interface.
88

99
```c#
10-
1110
using System;
1211
using Quartz;
1312

0 commit comments

Comments
 (0)