From 01e2ecf1cc57185873bb9364a3e52874a4a44326 Mon Sep 17 00:00:00 2001 From: Robert Spielmann Date: Mon, 6 Oct 2014 15:10:33 +0200 Subject: [PATCH 1/2] doc update --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 27176ed..05cdcc5 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,13 @@ You can use [pip][3] to install the dependencies via: I'll be distributing this code with a file EXAMPLE.csv. Try running - python makePlan.py 4 EXAMPLE.csv out/ output.pkl + python makePlan.py -n 4 EXAMPLE.csv out/ output.pkl -This will put a bunch of files into the "out/" directory (see OUTPUT FILE LIST) +where "out/" must already exist. This will put a bunch of files into the "out/" directory (see OUTPUT FILE LIST). Now try running - python makePlan.py 3 out/output.pkl + python makePlan.py -n 3 out/output.pkl This uses the plan stored in output.pkl instead of calculating a new one. It will create files for 3 agents instead of 4. @@ -77,11 +77,11 @@ No promises # Usage - python makePlan.py [-b] agent_count input_file [output_directory] [output_file] + python makePlan.py [-b] -n agent_count input_file [output_directory] [output_file] -b: Include this option if you like your maps blue instead of green for any reason - agent_count: Number of agents for which to make a plan + -n agent_count: Number of agents for which to make a plan input_file: One of two types of files: .csv format: From f68cc310dd081636d158d87c8e485aa734286396 Mon Sep 17 00:00:00 2001 From: Robert Spielmann Date: Mon, 6 Oct 2014 15:12:08 +0200 Subject: [PATCH 2/2] doc update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 05cdcc5..f0bd6a9 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ No promises python makePlan.py [-b] -n agent_count input_file [output_directory] [output_file] - -b: Include this option if you like your maps blue instead of green for any reason + -b: Include this option if you like your maps blue instead of green for any reason -n agent_count: Number of agents for which to make a plan