From f75f15b599fcebe2d2848b252afd1caa673cd6c1 Mon Sep 17 00:00:00 2001 From: Mak Date: Mon, 13 Apr 2026 17:49:32 -0600 Subject: [PATCH] Update README.md Included a section on formatting to make it more clear for users how to use command input files. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3de716a..cf63041 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ Compound scripts allow the user to automate complicated workflows directly withi Also, a complicated workflow can be run in a single computation---no need to wait for finished jobs and resubmissions. +## Special Formatting and file extention note +1. While the extention of your input files can be anything, It's recommedned to keep them to the traditional ".inp" (input) or ".cmp" (compound) extentions. +2. While not shown in any of the following examples, a compound script REQUIRES the `%Compound` block to come before any variables. Additionally, if you desire your job to be multi-threaded you will need the `%maxcore` and `%Pal NPROCSHARED` blocks to be above the `%Compound` block +3. Note the `%maxcore` and `%Pal NPROCSHARED` blocks can only be supplied once. All subsequent New_Step sections will re-use the same memory and number of CPUs. ## How do I contribute?