6 How to run it

just setup

A new user does not know which commands to run first. The README now says how to run tally, its tests and its report. Only README.md changes, so the code is as it was.

uv run tally --top 3 data/corpus.txt

Ask: what else would a new user ask before they run it?

What changed

  • README.md: a section, "Run it", with the commands that a new user needs first. 10 lines added. The file.
    • look at ## Run it
The diff of README.md
@@ -1,3 +1,13 @@
 # tally
 
 Count the words in a text.
+
+## Run it
+
+Make the environment, the corpus and the report first. Then count the words of a file:
+
+    just setup
+    uv run tally data/corpus.txt
+
+`uv run tally --top 10 data/corpus.txt` prints only the ten most common words. `just test` runs the tests, and
+`just report` writes the ten most common words of the corpus to `build/top.txt`.

This change on GitHub. The code after it.