Mercury provides a cross-platform base layer for configuring the system.
"Why Mercury?" I hear you say. Primarily because Mercury was the Roman god of boundaries, communication and travel which aligns with this project's main goals:
- Boundaries: Project Mercury will form the boundary between hardware and what a consumer wants to do, abstracting away platform-specifics.
- Communication: Project Mercury provides a translation abstraction layer between the consumers and the base hardware, regardless of what that may be.
- Travel: Project Mercury is designed to be cross-platform from the beginning, allowing the same apps to be delivered across multiple different platforms by providing the base abstraction upon which all functionality can be leveraged.
Additionally, Project Mercury was the first United States human spaceflight program and likewise this is our first foray into colonising other planets (well, hardware).
Finally, Mercury is an element known to send people mad when they inhale too much of the fumes: hopefully not a sign of things to come with this project.
The technologies which are used in this project are:
c++11
cmake
conan
cpplint
doxygen
googletest
lcov
make
qt
sphinxpip3 install -r requirements-dev.txt
brew install cmake doxygen lcov qtpip3 install -r requirements-dev.txt
apt-get install cmake doxygen lcov qtmakeCMake (3.10.0 minimum to allow us to use some of the newer goodies) is used to build both the project and the tests.
make testTests are written with Google Test. Conan will handle installing all the dependencies here. Coverage reports are generated with lcov and a report can be found in coverage/index.html after running the tests.
make lintC++ linting is performed by the CppLint tool. The configuration is in the CPPLINT.cfg file.
Automatic checking of the linting is performed by CodeFactor for your convenience.
make docsThe base documentation files can be found in the docs/source directory.
C++ code is marked up with Doxygen.