Skip to content

Commit 9ccbf2e

Browse files
committed
Docs: readme and contributing updates.
- Small improvement to Windows libusb install help, and removed note about the known issue that no longer applies. - Replaced reference to Mbed contributing docs with License section. - Added a short checklist under contributing Process.
1 parent c4571d9 commit 9ccbf2e

File tree

2 files changed

+33
-12
lines changed

2 files changed

+33
-12
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,21 @@ Other formatting requirements:
1414
- 4 space indents, no tabs are allowed.
1515
- No trailing whitespace.
1616
- All source files must end with a newline (an empty line at the end).
17-
- Lines should generally not be longer than 120 characters, though this is not a hard rule.
17+
- Lines should generally not be longer than 120 characters, though this is not a hard rule. Overall readability
18+
is more important.
1819

1920

2021
## Process
2122

23+
Before you submit your changes, please ensure that:
24+
25+
- The code meets style requirements listed above.
26+
- You have added your copyright below existing copyrights in the files you modified. New files should have only
27+
your copyright. See the License section below for more.
28+
- Changes have been tested locally to the extent possible. (Obviously, we don't expect you to have as many
29+
test boards as we do.)
30+
- Your code works with both Python 2 and Python 3.
31+
2232
Please create a pull request in GitHub with your contribution. Before creating the pull request,
2333
please ensure that all tests pass. We also run the tests on a wide range of boards for every pull
2434
request using our CI setup. Changes must pass on all tested boards before the the pull request can
@@ -29,8 +39,19 @@ environment. The [automated tests guide](docs/automated_tests.md) provides infor
2939
available types of tests and describes how to run the tests.
3040

3141

32-
## More
42+
## License
43+
44+
By creating a pull request on GitHub, you are granting license your contributions under the same Apache 2.0
45+
license as the original code. However, the copyright on contributions is retained by their author(s). Please
46+
add your copyright below existing copyrights in the license header at the top of the source file. If you are
47+
doing the work for your employer, you should use your employer's copyright. If a file is newly added by you,
48+
it must contain the standard license header with your copyright. Please note that we do not list changes in
49+
each source file by copyright owner, as this becomes a burden to maintain.
50+
51+
Contributing source code that is already licensed using a license other than Apache 2.0 is possible, but each
52+
case must be considered individually. (If you are the owner of the source code, then you have the right to
53+
relicense to Apache 2.0.) The most important thing is that the license is compatible with Apache 2.0. Examples
54+
are MIT, the BSD licenses, and similar. GPL-licensed code is expressly disallowed to be contributed, as the
55+
GPL is not compatible with Apache 2.0 (or any of the Apache-compatible licenses).
56+
3357

34-
For more information about contributing, see the Mbed OS [contributor
35-
documentation](http://os.mbed.com/contributing). Although this documentation is written primarily
36-
with Mbed OS in mind, much of it applies directly to pyOCD, as well.

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ API to enable low-level target control. A common use for the Python API is to ru
1010
tests.
1111

1212
Upwards of 70 popular MCUs are supported built-in. In addition, through the use of CMSIS-Packs,
13-
nearly every Cortex-M device on the market is supported.
13+
[nearly every Cortex-M device](https://www.keil.com/dd2/pack/) on the market is supported.
1414

1515
The `pyocd` command line tool gives you total control over your device with these subcommands:
1616

@@ -22,6 +22,7 @@ The `pyocd` command line tool gives you total control over your device with thes
2222
that provide additional target device support.
2323
- `commander`: Interactive REPL control and inspection of the MCU.
2424
- `server`: Share a debug probe with a TCP/IP server.
25+
- `reset`: Hardware or software reset of a device.
2526
- `list`: Show connected devices.
2627

2728
The API and tools provide these features:
@@ -143,12 +144,10 @@ How to install libusb depends on your OS:
143144

144145
- macOS: use Homebrew: `brew install libusb`
145146
- Linux: should already be installed.
146-
- Windows: download libusb from [libusb.info](https://libusb.info/) and place the DLL in your Python
147+
- Windows: download libusb from [libusb.info](https://libusb.info/) and place the .dll file in your Python
147148
installation folder next to python.exe. Make sure to use the same 32- or 64-bit architecture as
148-
your Python installation. *Note: due to a
149-
[known issue](https://github.com/mbedmicro/pyOCD/issues/684), the current recommendation is to use
150-
[libusb version 1.0.21](https://github.com/libusb/libusb/releases/tag/v1.0.21) on Windows instead
151-
of the most recent version.*
149+
your Python installation. The latest release is [available on GitHub](https://github.com/libusb/libusb/releases);
150+
download the .7z archive under Assets. Use the library from the VS2019 folder in the archive.
152151

153152
### udev rules on Linux
154153

@@ -227,7 +226,8 @@ Contributions
227226
-------------
228227

229228
We welcome contributions to pyOCD in any area. Please see the [contribution
230-
guidelines](CONTRIBUTING.md) for detailed requirements for contributions.
229+
guidelines](CONTRIBUTING.md) for detailed requirements for contributions. In order foster a healthy
230+
and safe community, we expect contributors to follow the [code of conduct](CODE_OF_CONDUCT.md).
231231

232232
To report bugs, please [create an issue](https://github.com/mbedmicro/pyOCD/issues/new) in the
233233
GitHub project.

0 commit comments

Comments
 (0)