From eb027f1c19f7c3a21bc53c9d8bd3e0350ac0554b Mon Sep 17 00:00:00 2001 From: Joscha Date: Wed, 6 Nov 2019 18:45:16 +0000 Subject: [PATCH] Reword parts of the help --- README.md | 18 +++++++++--------- app/MimaRun.hs | 10 +++++----- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5343eff..94ba662 100644 --- a/README.md +++ b/README.md @@ -21,22 +21,22 @@ at address 0 (i. e. the first block). This program can load and run `.mima` files. ``` -$ ./mima-run --help +$ mima-run --help Usage: mima-run INFILE [-n|--steps N] [-d|--dump OUTFILE] [-q|--quiet] [-s|--sparse] [-r|--norun] Available options: -h,--help Show this help text - INFILE The memory dump to load and execute + INFILE The binary memory dump to load and execute -n,--steps N How many instructions to execute (if not specified, runs until HALT or execution exception) - -d,--dump OUTFILE If specified, the MiMa's memory is dumped to this - file after execution is finished - -q,--quiet Whether to print the memory after execution is - finished - -s,--sparse Whether to print memory locations that contain 0 - -r,--norun Don't run the MiMa. Continues as if the initial state - was the result of running the MiMa. + -d,--dump OUTFILE If specified, write the MiMa's binary memory dump to + this file after execution is finished + -q,--quiet Don't print the memory dump + -s,--sparse Don't print memory locations containing only 0x000000 + in the memory dump + -r,--norun Don't run the MiMa. Use the initial state for all + further actions ``` ## Conventions diff --git a/app/MimaRun.hs b/app/MimaRun.hs index 147016b..b259ab5 100644 --- a/app/MimaRun.hs +++ b/app/MimaRun.hs @@ -24,7 +24,7 @@ settingsParser :: Parser Settings settingsParser = Settings <$> strArgument (metavar "INFILE" - <> help "The memory dump to load and execute") + <> help "The binary memory dump to load and execute") <*> (optional . option auto) (long "steps" <> short 'n' @@ -34,19 +34,19 @@ settingsParser = Settings (long "dump" <> short 'd' <> metavar "OUTFILE" - <> help "If specified, the MiMa's memory is dumped to this file after execution is finished") + <> help "If specified, write the MiMa's binary memory dump to this file after execution is finished") <*> flag False True (long "quiet" <> short 'q' - <> help "Whether to print the memory after execution is finished") + <> help "Don't print the memory dump") <*> flag False True (long "sparse" <> short 's' - <> help "Whether to print memory locations that contain 0") + <> help "Don't print memory locations containing only 0x000000 in the memory dump") <*> flag False True (long "norun" <> short 'r' - <> help "Don't run the MiMa. Continues as if the initial state was the result of running the MiMa.") + <> help "Don't run the MiMa. Use the initial state for all further actions") opts :: ParserInfo Settings opts = info (helper <*> settingsParser) $ fullDesc <> failureCode 1