summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.txt3
-rw-r--r--doc/MANUAL.txt5
-rw-r--r--testrepository/commands/quickstart.py3
3 files changed, 10 insertions, 1 deletions
diff --git a/README.txt b/README.txt
index 985df45..3111bb5 100644
--- a/README.txt
+++ b/README.txt
@@ -29,6 +29,9 @@ Test Repository is under BSD / Apache 2.0 licences. See the file COPYING in the
Quick Start
~~~~~~~~~~~
+Create a config file::
+ $ touch .testr.conf
+
Create a repository::
$ testr init
diff --git a/doc/MANUAL.txt b/doc/MANUAL.txt
index 7a7b327..fafd16e 100644
--- a/doc/MANUAL.txt
+++ b/doc/MANUAL.txt
@@ -11,6 +11,8 @@ Typical workflow is to have a repository into which test runs are inserted, and
then to query the repository to find out about issues that need addressing. For
instance, using the sample subunit stream included with Test repository::
+ # Note that there is a .testr.conf already:
+ ls .testr.conf
# Create a store to manage test results in.
$ testr init
# add a test result (shows failures)
@@ -23,6 +25,7 @@ instance, using the sample subunit stream included with Test repository::
$ testr failing
Most commands in testr have comprehensive online help, and the commands::
+
$ testr help
$ testr commands
@@ -31,7 +34,7 @@ Will be useful to explore the system.
Running tests
~~~~~~~~~~~~~
-Test Repository can be taught how to run your tests by setting up a .testr.conf
+testr can be taught how to run your tests by setting up a .testr.conf
file in your cwd. A file like::
[DEFAULT]
diff --git a/testrepository/commands/quickstart.py b/testrepository/commands/quickstart.py
index eca39ec..35594ba 100644
--- a/testrepository/commands/quickstart.py
+++ b/testrepository/commands/quickstart.py
@@ -52,6 +52,9 @@ Test Repository is under BSD / Apache 2.0 licences. See the file COPYING in the
Quick Start
~~~~~~~~~~~
+Create a config file::
+ $ touch .testr.conf
+
Create a repository::
$ testr init