README

README.rst

@@ -11,8 +11,10 @@ This package contains:
 
 Requirements: Python 3.8+, Firebird 3+
 
-Usage Guide
------------
+You should definitelly read the `QA suite documanetation`_ !
+
+Quickstart
+----------
 
 1. Clone the git repository
 
@@ -20,20 +22,54 @@ Usage Guide
 
    pip install -e .
 
-3. Create / edit `firebird.conf` file. The default file defines `local` server with default
-   SYSDBA password. You may change it or add more servers.
+3. Adjust Firebird server configuration.
+
+   Firebird 3::
+
+     # Required
+     ExternalFileAccess = Full
+     AuthServer = Srp, Legacy_Auth
+     UserManager = Srp, Legacy_UserManager
+     WireCrypt = Enabled
+
+     # Recommended
+     DefaultDbCachePages = 10000
+     MaxUnflushedWrites = -1
+     MaxUnflushedWriteTime = -1
+     BugcheckAbort = 1
+
+   Firebird 4+::
+
+     # Required
+     ExternalFileAccess = Full
+     AuthServer = Srp256, Legacy_auth
+     UserManager = Srp, Legacy_UserManager
+     ReadConsistency = 0
+     WireCrypt = Enabled
+     ExtConnPoolSize = 10
+     ExtConnPoolLifeTime = 10
+
+     # Recommended
+     DefaultDbCachePages = 10000
+     MaxUnflushedWrites = -1
+     MaxUnflushedWriteTime = -1
+     BugcheckAbort = 1
 
 3. Use pytest to run tests.
 
-   The plugin adds nex options to pytests::
+   The plugin adds next options to pytest::
 
       Firebird server:
-        --server=SERVER       Server configuration name
-        --bin-dir=PATH        Path to directory with Firebird utilities
-        --protocol={xnet,inet,inet4,wnet}
-                              Network protocol used for database attachments
-        --runslow             Run slow tests
-        --save-output         Save output from isql and other executed utilities into ./out subdirectory
+         --server=SERVER       Server configuration name
+         --bin-dir=PATH        Path to directory with Firebird utilities
+         --protocol={xnet,inet,inet4,wnet}
+                               Network protocol used for database attachments
+         --runslow             Run slow tests
+         --save-output         Save test std[out|err] output to files
+         --skip-deselected={platform,version,any}
+                               SKIP tests instead deselection
+         --extend-xml          Extend XML JUnit report with additional information
+         --install-terminal    Use our own terminal reporter
 
    To run all tests (except slow ones) against local server use next command::
 
@@ -42,3 +78,4 @@ Usage Guide
   Note: If plugin fails to determine the directory with Firebird utilities (isql, gbak etc.),
         use `--bin-dir` option to specify it.
 
+.. _QA suite documanetation: https://firebird-qa.readthedocs.io