Following the old quick start information would not get a new user to run
tests with their configuration, because it was not accurate to how the check
script actually works.
By default, the script looks for *.config files in HOST_CONFIG_DIR, which
defaults to '.config' if unset. The README now reflects that.
Signed-off-by: Gabriel Niebler <gniebler@xxxxxxxx>
---
README | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/README b/README
index 9f01aa10..7e36905e 100644
--- a/README
+++ b/README
@@ -61,8 +61,10 @@ Preparing system for tests:
- setup your environment
Quick start:
- - copy local.config.example to local.config and edit as needed
- Or:
+ - set HOST_CONFIG_DIR to a path of your choice (ideally outside the git tree)
+ - copy configs/localhost.config there and edit as needed
+ - also consult local.config.example for inspiration
+ These are the most important environment variables you may want to set there:
- setenv TEST_DEV "device containing TEST PARTITION"
- setenv TEST_DIR "mount point of TEST PARTITION"
- optionally:
--
2.35.1
