Write English documentation

hoaproject / Test

The Hoa\Test library.

https://hoa-project.net/

11 stars 10 forks source link

Write English documentation #37

Closed Hywan closed 9 years ago

Hywan commented 9 years ago

Fix #38.

TOC and progression:

[x] Introduction
- [x] Nature of tests
- [x] Test framework
- [x] Research papers
[x] Writing tests
- [x] Automated unit tests
- [x] Automatic test data generation
- [x] Automatically generated tests
[x] Run tests
- [x] Interpreting the test result
- [x] Debugging mode
- [x] Select tests to run
- [x] Choose the PHP virtual machine
- [x] Test execution engine
[x] Virtual file system
- [x] Files or directories
- [x] Permissions
- [x] Access-, change- and modify-time
[x] Conclusion

Hywan commented 9 years ago

Asking a first peer review please! /cc @hoaproject/hoackers

Hywan commented 9 years ago

To test, write the following composer.json:

{
    "require": {
        "hoa/test": "dev-documentation"
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/Hywan/Test"
        }
    ]
}

Then:

$ composer install
$ vendor/bin/hoa devtools:documentation

and here you go.

Hywan commented 9 years ago

First review done. I am going to rebase all the patches as a single one.