Skip to content

Commit cb26a52

Browse files
author
Markus Humm
committed
Forgot to commit latest changes
Fixed some errors in these description files.
1 parent 7a11d34 commit cb26a52

File tree

3 files changed

+21
-14
lines changed

3 files changed

+21
-14
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
We welcome contributions from the Delphi community!
22

3-
If you like to contribute then either submit a pull request with your proposed
3+
If you like to contribute, either submit a pull request with your proposed
44
changes along with a description about what you like to achieve with the
55
modification/addition you propose or send an e-mail to the person listed as main contact
66
in notice.txt

NOTICE.txt

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ Version 1.0
44
This work is based on prior art from TridenT and on the code coverage
55
library/tool, which is included in binary form.
66

7-
Copyright (c) 2022 Markus Humm (markus [dot] humm [at] googlemail [dot] com) (main contact)
7+
Copyright (c) 2022-2022 Markus Humm (markus [dot] humm [at] googlemail [dot] com) (main contact)
88

99
This software is licensed to you under the MPL 1.1 license.
10-
A copy of the license text can be found in the LICENSE.txt file in this project.Parts of the work loosely based on the works of Wolfgang Erhardt, who is
11-
unfortunately dead already.
10+
A copy of the license text can be found in the LICENSE.txt file in this project.

README.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,33 @@ The current version 1.0 is compatible with Delphi 11.0 Alexandria and most
2626
likely with 10.4 Sydney.
2727

2828
## What is the current status of this project?
29-
Development just started.
29+
The current version in this repository is considered to be a release candidate for
30+
V1.0. It looks like it still has a few small quirks with disabling next button in
31+
editing mode but other than that it looks fine.
3032

3133
## Where can I get further information? For example if I'd like to contribute?
3234
In the root folder of the project you will find further files with information about
3335
this project like *NOTICE.txt*, *CONTRIBUTING.md*, *SECURITY.md*.
3436

3537
## How to install?
36-
Just run the installer provided in the Install\Output directory.
37-
Run the ??? from the installation directory where you installed the tool.
38-
When run for the first time it will display a dialog you can use to add it to the Tools
39-
menus of all Delphi versions/profiles it finds on your computer.
38+
Just open and run the project provided in the Source directory.
39+
When run for the first time or when you installed another version of the IDE it will
40+
display a dialog you can use to add it to the Tools menus of all Delphi
41+
versions/profiles it finds on your computer.
4042

4143
## How to use it?
4244

43-
1. Make sure your project has MAP-file generation turned on in linker settings.
44-
2. If not done yet develop some DUnit/DUnitX unit tests for your peoject.
45-
3. Run the tool and generate a code coverage project for your project. The tool provides
45+
1. Make sure your project has detailed MAP-file generation turned on in linker settings.
46+
2. If not done yet develop some DUnit/DUnitX unit tests for your project. If you set it
47+
up as a console project, you only need to press enter after the tests have run,
48+
otherwise you need to start them manually when running code coverage.
49+
3. Run this tool and generate a code coverage project for your project. The tool provides
4650
a wizzard for this.
4751
4. Save the generated project.
4852
5. Run the generated project. It should start your unit tests.
49-
6. Run your unit testsand close the test runner.
50-
7. The coverage report should be generated in the format(s) you specified in the wizard
53+
6. Run your unit tests and close the test runner.
54+
7. The coverage report should be generated in the format(s) you specified in the wizard.
55+
If you checked HTML format, the result will be displayed in code coverage wizard plus,
56+
but you can still open it in any browser outside this tool.
57+
58+
Now: enjoy!

0 commit comments

Comments
 (0)