Commit 3038fff8 by Tobias Schuele

Updated CHANGELOG.md and README.md.

parent f46f8033
Embedded Multicore Building Blocks (EMBB) Embedded Multicore Building Blocks (EMB²)
========================================= =========================================
Version 0.2.1
-------------
### Bug fixes:
- Fixed implementation of atomic operations on ARM.
- Fixed bug in HelpScan routine of hazard pointer implementation.
- Replaced inclusion of non-standard header malloc.h with stdlib.h.
### Features:
- Added embb_core_count_available() implementation for FreeBSD.
### Build system:
- Added initial support for Clang.
- Added initial support for Travis.
- Fixed "Policy CMP0026 is not set" warning of CMake >= 3.0.2.
- Made build independent of build-dir / source-dir location.
- Fixed remaining GCC, Clang, MSVC, and cpplint warnings.
- Replaced /bin/bash with /usr/bin/env bash in scripts.
- Added executable flag to shell scripts.
- Omitted Doxygen "Makefiles" from tarball.
- Included patchlevel in name of installation directory on Linux.
- Added LaTeX .bbl and .blg files to ignore list.
### Documentation:
- Updated README file, created CHANGELOG file, and added markdown support.
- Corrected license in COPYING.md (BSD 2-clause).
- Changed default Doxygen level for API to two.
- Added check for Doxyfile.in (if not present, do not add Doxygen target).
- Added PDF image of building blocks and updated tutorial.tex.
- Fixed typos and wording.
Version 0.2.0 Version 0.2.0
------------- -------------
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
Overview Overview
======== --------
The Embedded Multicore Building Blocks (EMB²) are an easy to use yet powerful The Embedded Multicore Building Blocks (EMB²) are an easy to use yet powerful
and efficient C/C++ library for the development of parallel applications. EMB² and efficient C/C++ library for the development of parallel applications. EMB²
...@@ -38,7 +38,7 @@ of any other concurrent operations on the same data structure. ...@@ -38,7 +38,7 @@ of any other concurrent operations on the same data structure.
Community and Contact Community and Contact
===================== ---------------------
Project home: Project home:
- https://github.com/siemens/embb - https://github.com/siemens/embb
...@@ -61,13 +61,13 @@ Contact: ...@@ -61,13 +61,13 @@ Contact:
License License
======= -------
See the file "COPYING.md" in the project's root directory. See the file "COPYING.md" in the project's root directory.
Requirements Requirements
============ ------------
This project is based on the standards C99 (for C code) and C++03 (for C++ This project is based on the standards C99 (for C code) and C++03 (for C++
code) to be usable on a wide range of target systems. It has been tested on code) to be usable on a wide range of target systems. It has been tested on
...@@ -87,7 +87,7 @@ contact us: embb-dev@googlegroups.com. ...@@ -87,7 +87,7 @@ contact us: embb-dev@googlegroups.com.
Directory Structure Directory Structure
=================== -------------------
EMB² is a technology stack consisting of various building blocks. For some of EMB² is a technology stack consisting of various building blocks. For some of
them, there exist C and C++ versions, others are only implemented in C++. The them, there exist C and C++ versions, others are only implemented in C++. The
...@@ -115,7 +115,7 @@ data structures for storing object in an organized and thread-safe way. ...@@ -115,7 +115,7 @@ data structures for storing object in an organized and thread-safe way.
Build and Installation Build and Installation
====================== ----------------------
Note: It is recommended to build from a packaged release file and not from a Note: It is recommended to build from a packaged release file and not from a
snapshot of the repository in order to get the documentation and the examples snapshot of the repository in order to get the documentation and the examples
...@@ -129,8 +129,7 @@ and change to the project's root directory. Create a subdirectory, where you ...@@ -129,8 +129,7 @@ and change to the project's root directory. Create a subdirectory, where you
want to build the library, e.g., "build". Change to that subdirectory. It is want to build the library, e.g., "build". Change to that subdirectory. It is
assumed that the project's root directory is now the parent directory. assumed that the project's root directory is now the parent directory.
1. Generation of native build files ### 1. Generation of native build files
-----------------------------------
Choose an appropriate build file generator for your system. Choose an appropriate build file generator for your system.
...@@ -174,8 +173,7 @@ For a Windows build (VS 2013, x86) without exception handling, type ...@@ -174,8 +173,7 @@ For a Windows build (VS 2013, x86) without exception handling, type
Note that "Visual Studio 12" refers to the version number of Visual Studio and Note that "Visual Studio 12" refers to the version number of Visual Studio and
not to the year in which it was released (2013). not to the year in which it was released (2013).
2. Compiling and linking ### 2. Compiling and linking
------------------------
As the next step, you can compile the library using the generated build files. As the next step, you can compile the library using the generated build files.
On Linux, the build mode (Release|Debug) is already given in the build files, On Linux, the build mode (Release|Debug) is already given in the build files,
...@@ -189,8 +187,7 @@ For a Windows Release build, type ...@@ -189,8 +187,7 @@ For a Windows Release build, type
cmake --build . --config Release cmake --build . --config Release
3. Running the tests ### 3. Running the tests
--------------------
To check whether EMB² was compiled correctly, run the tests. The test To check whether EMB² was compiled correctly, run the tests. The test
executables are contained in the subfolder "binaries". executables are contained in the subfolder "binaries".
...@@ -205,8 +202,7 @@ On Windows, type ...@@ -205,8 +202,7 @@ On Windows, type
If no error message occurs, EMB² is working fine. If no error message occurs, EMB² is working fine.
4. Installation ### 4. Installation
---------------
The default installation path on Linux is The default installation path on Linux is
...@@ -234,13 +230,12 @@ installation has to be run with administrator / root privileges. ...@@ -234,13 +230,12 @@ installation has to be run with administrator / root privileges.
Using the Library Using the Library
================= -----------------
To use EMB², the include files have to be made available during compilation of To use EMB², the include files have to be made available during compilation of
your application and the libraries have to be added during linking. your application and the libraries have to be added during linking.
1. Using C++ ### 1. Using C++
------------
If you want to use the C++ functionalities of EMB², you have to link the If you want to use the C++ functionalities of EMB², you have to link the
following libraries (names will be different on Windows and on Linux) in the following libraries (names will be different on Windows and on Linux) in the
...@@ -256,8 +251,7 @@ The C++ header files can be included as follows: ...@@ -256,8 +251,7 @@ The C++ header files can be included as follows:
#include<embb/containers/containers.h> #include<embb/containers/containers.h>
#include<embb/dataflow/dataflow.h> #include<embb/dataflow/dataflow.h>
2. Using C ### 2. Using C
----------
The following libraries have to be linked in the given order: The following libraries have to be linked in the given order:
...@@ -270,7 +264,7 @@ The C header files can be included as follows: ...@@ -270,7 +264,7 @@ The C header files can be included as follows:
Documentation Documentation
============= -------------
EMB² comes with a tutorial, example programs, and an HTML reference EMB² comes with a tutorial, example programs, and an HTML reference
documentation describing the APIs, which can be found in the "doc" folder. documentation describing the APIs, which can be found in the "doc" folder.
...@@ -278,7 +272,7 @@ The root document of the HTML reference is "doc/reference/index.html". ...@@ -278,7 +272,7 @@ The root document of the HTML reference is "doc/reference/index.html".
Code Quality Code Quality
============ ------------
For the C++ parts of EMB², we respect most rules of the "Google C++ Style For the C++ parts of EMB², we respect most rules of the "Google C++ Style
Guide" which are checked using the cpplint tool. However, we ignore some Guide" which are checked using the cpplint tool. However, we ignore some
...@@ -290,7 +284,7 @@ code using Cppcheck, a static analysis tool for C++. ...@@ -290,7 +284,7 @@ code using Cppcheck, a static analysis tool for C++.
Known Bugs and Limitations Known Bugs and Limitations
========================== --------------------------
- The MTAPI implementation is currently limited to homogeneous systems. - The MTAPI implementation is currently limited to homogeneous systems.
Support for heterogeneous systems will be added in the near future. Support for heterogeneous systems will be added in the near future.
...@@ -301,7 +295,7 @@ Known Bugs and Limitations ...@@ -301,7 +295,7 @@ Known Bugs and Limitations
Development and Contribution Development and Contribution
============================ ----------------------------
The EMB² team welcomes all kinds of contributions, preferably as pull requests The EMB² team welcomes all kinds of contributions, preferably as pull requests
or patches via the development mailing lists (see above). If possible, please or patches via the development mailing lists (see above). If possible, please
...@@ -309,7 +303,7 @@ refer to a current snapshot of the development branch. ...@@ -309,7 +303,7 @@ refer to a current snapshot of the development branch.
Links Links
===== -----
- Multicore Association: - Multicore Association:
http://www.multicore-association.org http://www.multicore-association.org
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment