Software:

* Toolchain:

  * none

* Bugfixes:

  * none

* Enhancements:

  * none

Hardware:

* none

Documentation:

* Updated the repository README and aligned the license information.

------------------------------------------------------------------------------

Author: foxBMS

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,10 +10,10 @@ hardware that:
 We therefore release foxBMS with permissive licenses:
 
 - Hardware (layout, schematics) and documentation:
-  **Creative Commons Attribution 4.0 International License**
-- Software: **BSD 3-Clause License**
+  **Creative Commons Attribution 4.0 International License (SPDX short identifier: CC-BY-4.0)**
+- Software: **BSD 3-Clause License (SPDX short identifier: BSD-3-Clause)**
 
-For details see the [LICENSE](../LICENSE) file and the
+For details see the [LICENSE.md](../LICENSE.md) file and the
 [license documentation](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest/general_information/licenses/licenses.html).
 
 However foxBMS is not openly developed on GitHub (or any other platform). The

BSD-3-Clause.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License (BSD 3-Clause "New" or "Revised" License)
+
+Copyright (c) 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

CC-BY-4.0.txt

@@ -2,6 +2,32 @@
 Changelog
 =========
 
+**Release 1.6.8**
+
+Software:
+
+* Toolchain:
+
+  * none
+
+* Bugfixes:
+
+  * none
+
+* Enhancements:
+
+  * none
+
+Hardware:
+
+* none
+
+Documentation:
+
+* Updated the repository README and aligned the license information.
+
+------------------------------------------------------------------------------
+
 **Release 1.6.7**
 
 Software:

CHANGELOG.rst

@@ -0,0 +1,37 @@
+# foxBMS Licenses
+
+## foxBMS Hardware and Documentation License
+
+- foxBMS hardware and documentation is licensed under the
+  Creative Commons Attribution 4.0 International License.
+  The license can be obtained from https://creativecommons.org/licenses/by/4.0/.
+- The license text is found in [CC-BY-4.0.txt](CC-BY-4.0.txt).
+- The SPDX short identifier is
+  [CC-BY-4.0](https://spdx.org/licenses/CC-BY-4.0.html).
+
+## foxBMS Software License
+
+- foxBMS software is licensed under the BSD 3-Clause License.
+- The license text is found in [BSD-3-Clause.txt](BSD-3-Clause.txt).
+- The SPDX short identifier is
+  [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html).
+
+## Further Information
+
+We kindly request you to use one or more of the following phrases to refer to
+foxBMS in your hardware, software, documentation or advertising materials:
+
+- ″This product uses parts of foxBMS®″
+- ″This product includes parts of foxBMS®″
+- ″This product is derived from foxBMS®″
+
+If you use foxBMS in your products, we encourage you to contact us at:
+
+```
+CONTACT INFORMATION
+Fraunhofer IISB
+Schottkystrasse 10
+91058 Erlangen, Germany
+mailto:[email protected]
+https://foxbms.org
+```

LICENSE

@@ -2,44 +2,36 @@
 
 > **_NOTE:_**
 > - This is the repository of the **first generation** of foxBMS
->   (https://github.com/foxBMS/foxbms-1)
+>   (https://github.com/foxBMS/foxbms)
 > - The **second generation** of foxBMS (foxBMS 2) is also found on Github
 >   (https://github.com/foxBMS/foxbms-2)
 
 foxBMS is a free, open and flexible development environment to design battery
 management systems. It is the first modular open source BMS development
 platform.
 
-The foxconda environment: This environment provides all the tools necessary
-to generate the documentation, compile the code for the MCUs and flash the
-generated binaries on the MCUs (e.g., ``Python``, ``git``, ``GCC``). foxconda
-can be downloaded [here](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/).
+## Documentation
 
-The starting point to get foxBMS is the foxBMS repository at
-[https://github.com/foxBMS/foxbms-1](https://github.com/foxBMS/foxbms-1), which
-contains all files for the foxBMS project.
+A current build of the documentation of this project can be found
+here:
+- [latest documentation build (of the most recent release)](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest/)
+- [list of all available documentation builds](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/)
 
-## foxBMS Repository
+## Changelog
 
-- In `foxbms\documentation` the configuration of the doxygen documentation for
-  the primary and secondary MCU can be found.
-- The software for the MCUs is found in `foxbms\embedded-software`. This
-  includes the Hardware Abstraction Layer (HAL), the real-time operating system
-  FreeRTOS and the BMS application itself.
-- The layout and schematic files for the foxBMS hardware are found in the
-  `foxbms\hardware`.
-- The build toolchain and other tools related to foxBMS are found in
-  `foxbms\tools`.
+The project changelog is found in
+[CHANGELOG.rst](./CHANGELOG.rst).
 
-A generated version of the Sphinx documentation can be found at
-[iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest).
-It explains the structure of the foxBMS hardware, how to install the foxconda
-environment and how to use foxconda to compile and flash the sources.
+## License
 
-## Building the Sources
+The license information of the project is found in [LICENSE.md](./LICENSE.md).
 
-For building the software, open a shell and type ``python tools\waf --help``.
-All available build options will be displayed. The top build directory is
-``foxbms\build``.
+Basically, the software is covered by the
+[**BSD 3-Clause License (SPDX short identifier: BSD-3-Clause)**](https://opensource.org/licenses/BSD-3-Clause)
+and the hardware and documentation by the
+[**Creative Commons Attribution 4.0 International License (SPDX short identifier: CC-BY-4.0)**](https://creativecommons.org/licenses/by/4.0/legalcode).
 
-[foxbms.org/](https://foxbms.org/)
+## Acknowledgment
+
+For funding acknowledgements and instructions on how to acknowledge foxBMS
+please see [foxbms.org/acknowledgements](https://foxbms.org/acknowledgements/).

LICENSE.md

@@ -38,7 +38,7 @@ PROJECT_NAME           = ""
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.6.7
+PROJECT_NUMBER         = 1.6.8
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -38,7 +38,7 @@ PROJECT_NAME           = ""
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.6.7
+PROJECT_NUMBER         = 1.6.8
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

documentation/doxygen/doxygen-primary.conf

@@ -38,7 +38,7 @@ PROJECT_NAME           = ""
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.6.7
+PROJECT_NUMBER         = 1.6.8
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a