From 1f40f17fb1def84e7d171c8c46459dabe0e24b44 Mon Sep 17 00:00:00 2001 From: Arian Weber Date: Tue, 19 Mar 2024 11:24:53 +0100 Subject: [PATCH] Mention config and sub-command help in prelude readme --- data/project-template/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/data/project-template/README.md b/data/project-template/README.md index 8dce684..7044f38 100644 --- a/data/project-template/README.md +++ b/data/project-template/README.md @@ -7,6 +7,7 @@ To get started you can run `pg-verify doctor` to verify your installation and gu you through the steps needed to install external addons like the NuSMV model checker. You can always run `pg-verify help` to get a list of available commands. +Run `pg-verify help ` to get more information about a specific command and its options. For example try running `pg-verify show png` to render a PNG image of your program graph and save that to your working directory. @@ -15,6 +16,7 @@ and save that to your working directory. There are a couple of prelude files and directories in your project to get you started: - `program-graph.rb`: This file defines the default program graph you will be working on +- `.pg-verify.yml`: This file can be used to configure pg-verify - `addon/`: This is the directory where you will place addon resources like the NuSMV executable. ## Writing specifications