From 324fc02b1ac89228e9bad4089bfa907a10392fe9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Thu, 20 Aug 2015 11:51:53 +0200 Subject: [PATCH] Synchronise top-level and yotta READMEs And fix two typos while at it --- README.rst | 8 ++++---- yotta/data/README.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index dd5cb2e84c..bc0204b3f2 100644 --- a/README.rst +++ b/README.rst @@ -153,7 +153,7 @@ We've included example programs for a lot of different features and uses in *pro Tests ===== -mbed TLS includes an elaborate test suite in *tests/* that initially requires Perl to generate the tests files (e.g. *test_suite_mpi.c*). These files are generates from a **function file** (e.g. *suites/test_suite_mpi.function*) and a **data file** (e.g. *suites/test_suite_mpi.data*). The **function file** contains the test functions. The **data file** contains the test cases, specified as parameters that will be passed to the test function. +mbed TLS includes an elaborate test suite in *tests/* that initially requires Perl to generate the tests files (e.g. *test_suite_mpi.c*). These files are generated from a **function file** (e.g. *suites/test_suite_mpi.function*) and a **data file** (e.g. *suites/test_suite_mpi.data*). The **function file** contains the test functions. The **data file** contains the test cases, specified as parameters that will be passed to the test function. For machines with a Unix shell and OpenSSL (and optionally GnuTLS) installed, additional test scripts are available: @@ -170,11 +170,11 @@ We provide some non-standard configurations focused on specific use cases in the Contributing ============ -We graciously accept bugs and contributions from the community. There are some requirements we need to fulfil in order to be able to integrate contributions in the main code. +We gratefully accept bugs and contributions from the community. There are some requirements we need to fulfil in order to be able to integrate contributions: -Simple bug fixes to existing code do not contain copyright themselves and we can integrate those without any issue. The same goes for trivial contributions. +- Simple bug fixes to existing code do not contain copyright themselves and we can integrate without issue. The same is true of trivial contributions. -For larger contributions, e.g. a new feature, the code possible falls under copyright law. We then need your consent to share in the ownership of the copyright. We have a form for that, which we will mail to you in case you submit a contribution or pull request that we deem this necessary for. +- For larger contributions, such as a new feature, the code can possibly fall under copyright law. We then need your consent to share in the ownership of the copyright. We have a form for this, which we will mail to you in case you submit a contribution or pull request that we deem this necessary for. Process ------- diff --git a/yotta/data/README.md b/yotta/data/README.md index c737f2a676..20503c3317 100644 --- a/yotta/data/README.md +++ b/yotta/data/README.md @@ -38,7 +38,7 @@ Please note you need to provide the exact name that will be used in the `#includ We gratefully accept bugs and contributions from the community. There are some requirements we need to fulfil in order to be able to integrate contributions: -* Simple bug fixes to existing code do not contain copyright themselves and we can integrate without issue. The same s true of trivial contributions. +* Simple bug fixes to existing code do not contain copyright themselves and we can integrate without issue. The same is true of trivial contributions. * For larger contributions, such as a new feature, the code can possibly fall under copyright law. We then need your consent to share in the ownership of the copyright. We have a form for this, which we will mail to you in case you submit a contribution or pull request that we deem this necessary for. @@ -46,7 +46,7 @@ To contribute, please: * [Check for open issues](https://github.com/ARMmbed/mbedtls/issues) or [start a discussion](https://tls.mbed.org/discussions) around a feature idea or a bug. -* Fork the [mbed TLS repository on Github](https://github.com/ARMmbed/mbedtls) to start making your changes. +* Fork the [mbed TLS repository on Github](https://github.com/ARMmbed/mbedtls) to start making your changes. As a general rule, you should use the "development" branch as a basis. * Write a test that shows that the bug was fixed or that the feature works as expected.