pts-core: Add more prominent link to documentation page to help users…

… answer all of the common questions...
phoronix-test-suite · Oct 10, 2021 · 60da8aa · 60da8aa
1 parent 9b5f139
commit 60da8aa
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,9 @@ are meant to be easily reproducible, easy-to-use, and support fully automated
 execution. The Phoronix Test Suite is open-source under the GNU GPLv3 license
 and is developed by Phoronix Media in cooperation with partners.
 
+[Phoronix Test Suite
+Documentation](https://github.com/phoronix-test-suite/phoronix-test-suite/blob/master/documentation/phoronix-test-suite.md)
+
 The Phoronix Test Suite itself is an open-source framework for conducting
 automated tests along with reporting of test results, detection of installed
 system software/hardware, and other features. This framework is designed to be

diff --git a/documentation/phoronix-test-suite.pdf b/documentation/phoronix-test-suite.pdf
diff --git a/documentation/stubs/readme-basics.txt b/documentation/stubs/readme-basics.txt
@@ -1,3 +1,6 @@
+
+[Phoronix Test Suite Documentation](https://github.com/phoronix-test-suite/phoronix-test-suite/blob/master/documentation/phoronix-test-suite.md)
+
 The Phoronix Test Suite itself is an open-source framework for conducting automated tests along with reporting of test results, detection of installed system software/hardware, and other features. This framework is designed to be an extensible architecture so that new test profiles and suites can be easily added to represent performance benchmarks, unit tests, and other quantitative and qualitative (e.g. image quality comparison and pass/fail) measurements. Available through OpenBenchmarking.org, a collaborative storage platform developed in conjunction with the Phoronix Test Suite, are more than 600 individual test profiles and more than 200 test suites available by default from the Phoronix Test Suite. Independent users are also able to upload their test results, profiles, and suites to OpenBenchmarking.org.
 
 A test profile is a single test that can be executed by the Phoronix Test Suite -- with a series of options possible within every test -- and a test suite is a seamless collection of test profiles and/or additional test suites. A test profile consists of a set of Bash/shell scripts and XML files while a test suite is a single XML file. Modules for the Phoronix Test Suite also allow for integration with git-bisect and other revision control systems for per-commit regression testing, system sensor monitoring, and other extras.