| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 1 | # Notes for NLSR developers |
| 2 | |
| 3 | If you are new to the NDN software community, please read the |
| Davide Pesavento | 1e9faf1 | 2023-01-21 16:04:50 -0500 | [diff] [blame^] | 4 | [Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md). |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 5 | |
| 6 | ## Licensing requirements |
| Yingdi Yu | 40cd1c3 | 2014-04-17 15:02:17 -0700 | [diff] [blame] | 7 | |
| Vince Lehman | c2e51f6 | 2015-01-20 15:03:11 -0600 | [diff] [blame] | 8 | Contributions to NLSR must be licensed under GPL 3.0 or compatible license. If you are |
| 9 | choosing GPL 3.0, please use the following license boilerplate in all `.hpp` and `.cpp` |
| 10 | files: |
| 11 | |
| 12 | Include the following header in all `.hpp` and `.cpp` files: |
| Yingdi Yu | 40cd1c3 | 2014-04-17 15:02:17 -0700 | [diff] [blame] | 13 | |
| 14 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| Davide Pesavento | ba8a4ed | 2021-10-13 21:28:43 -0400 | [diff] [blame] | 15 | /* |
| 16 | * Copyright (c) [Year(s)], [Copyright Holder(s)]. |
| Yingdi Yu | 40cd1c3 | 2014-04-17 15:02:17 -0700 | [diff] [blame] | 17 | * |
| 18 | * This file is part of NLSR (Named-data Link State Routing). |
| 19 | * See AUTHORS.md for complete list of NLSR authors and contributors. |
| 20 | * |
| 21 | * NLSR is free software: you can redistribute it and/or modify it under the terms |
| 22 | * of the GNU General Public License as published by the Free Software Foundation, |
| 23 | * either version 3 of the License, or (at your option) any later version. |
| 24 | * |
| 25 | * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; |
| 26 | * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 27 | * PURPOSE. See the GNU General Public License for more details. |
| 28 | * |
| 29 | * You should have received a copy of the GNU General Public License along with |
| 30 | * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>. |
| Davide Pesavento | ba8a4ed | 2021-10-13 21:28:43 -0400 | [diff] [blame] | 31 | */ |
| Yingdi Yu | 40cd1c3 | 2014-04-17 15:02:17 -0700 | [diff] [blame] | 32 | |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 33 | If you are affiliated with an NSF-supported NDN project institution, please use the [NDN Team License |
| 34 | Boilerplate](https://redmine.named-data.net/projects/nlsr/wiki/NDN_Team_License_Boilerplate_(NLSR)). |
| Vince Lehman | c2e51f6 | 2015-01-20 15:03:11 -0600 | [diff] [blame] | 35 | |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 36 | ## Recommendations |
| Yingdi Yu | 40cd1c3 | 2014-04-17 15:02:17 -0700 | [diff] [blame] | 37 | |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 38 | NLSR code is subject to the code style defined |
| 39 | [here](https://redmine.named-data.net/projects/nfd/wiki/CodeStyle). |
| Ashlesh Gawande | 39cf81a | 2018-02-22 13:37:07 -0600 | [diff] [blame] | 40 | |
| Davide Pesavento | 1b640fd | 2023-01-04 21:00:05 -0500 | [diff] [blame] | 41 | NLSR Developer's guide can be found |
| 42 | [here](https://github.com/named-data/NLSR/blob/developers-guide/NLSR-Developers-Guide.pdf). |