AuroraMiddleware/mbedtls
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some formatting and info about contributions to README.rst

Browse Source
This commit is contained in:
Paul Bakker 2014-05-02 13:11:59 +02:00
parent da13016d84
commit 5c7bc9c032
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.rst
View File

@ -9,7 +9,7 @@ There are currently three active build systems within the PolarSSL releases:
- Make
- CMake
- Microsoft Visual Studio
- Microsoft Visual Studio (Visual Studio 6 and Visual Studio 2010)
The main system used for development is CMake. That system is always the most up-to-date. The others should reflect all changes present in the CMake build system, but some features are not ported there by default.
@ -18,11 +18,11 @@ Make
We intentionally only use the absolute minimum of **Make** functionality, as we have discovered that a lot of **Make** features are not supported on all different implementations of Make on different platforms. As such, the Makefiles sometimes require some handwork or `export` statements in order to work for your platform.
In order to build the source using Make, just enter at the command line:
In order to build the source using Make, just enter at the command line::
make
In order to run the tests, enter:
In order to run the tests, enter::
make check
@ -33,7 +33,7 @@ In case you find that you need to do something else as well, please let us know
CMake
-----
In order to build the source using CMake, just enter at the command line:
In order to build the source using CMake, just enter at the command line::
cmake .
@ -52,14 +52,14 @@ Switching build modes in CMake is simple. For debug mode, enter at the command l
cmake -D CMAKE_BUILD_TYPE:String="Debug" .
In order to run the tests, enter:
In order to run the tests, enter::
make test
Microsoft Visual Studio
-----------------------
The build files for Microsoft Visual Studio are generated for Visual Studio 6.0 all future Visual Studio's should be able to open and use this older version of the build files.
The build files for Microsoft Visual Studio are generated for Visual Studio 6.0 and Visual Studio 2010.
The workspace 'polarssl.dsw' contains all the basic projects needed to build the library and all the programs. The files in tests are not generated and compiled, as these need a perl environment as well.
@ -71,11 +71,24 @@ We've included example programs for a lot of different features and uses in *pro
Tests
=====
PolarSSL includes a 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 template for each test function. The **data file** contains the test cases, specified as parameters that should be pushed into a template function.
PolarSSL 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 template for each test function. The **data file** contains the test cases, specified as parameters that should be pushed into a template function.
Configurations
==============
We provide some non-standard configurations focused on specific use cases in the configs/ directory. You can read more about those in configs/README.txt
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.
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.
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.
Process
-------
#. `Check for open issues <https://github.com/polarssl/polarssl/issues>`_ or
`start a discussion <https://polarssl.org/discussions>`_ around a feature
idea or a bug.