From 4f2f0431d1db1399e0edd04b1544194772bbf21a Mon Sep 17 00:00:00 2001 From: Adrian Heine Date: Fri, 23 Jul 2021 15:33:28 +0200 Subject: [PATCH] Document usage as a library --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8d3cd2f..747cf78 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ cargo run To exit the simulation, press q, ESC or Ctrl+c. +## Using as a library + +`src/main.rs` is a pretty minimal example of the currently exposed high-level functionality. `gntag::actor` includes simpler actor iplementations and all the types, `gntag::world` contains `ActualWorld` and `WorldState`. + ## Tests A few tests can be run with: