... | ... | @@ -3,9 +3,31 @@ General things |
|
|
|
|
|
#### 1) Copyright
|
|
|
|
|
|
You will find different Licence policies along the code: while Miosix's code was released unde the GPL license, Boardcore's lincensing is still under discussion.
|
|
|
|
|
|
Anyways, you should indeed put a copyright statement as a first thing in every file.
|
|
|
You will find different Licence policies along the code: while Miosix's code was released under the GPL license, Boardcore and every Skyward code is licensed under the MIT License. Include the following snipped at the beginning of every file: (remember to fill in your name and year)
|
|
|
```
|
|
|
/*
|
|
|
* Copyright (c) {year} Skyward Experimental Rocketry
|
|
|
* Authors: {authors}
|
|
|
*
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
*
|
|
|
* The above copyright notice and this permission notice shall be included in
|
|
|
* all copies or substantial portions of the Software.
|
|
|
*
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
* THE SOFTWARE.
|
|
|
*/
|
|
|
```
|
|
|
|
|
|
#### 2) Includes
|
|
|
*Pro Tip*: In src/shared/Common.h you will find many frequently used headers. Check them!
|
... | ... | |