-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jean-Francois Panisset <[email protected]>
- Loading branch information
1 parent
63189e3
commit 7c83609
Showing
1 changed file
with
20 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,20 @@ | ||
# aswf_sample_project | ||
ASWF Sample Project | ||
# ASWF Sample Project | ||
|
||
The purpose of this project is to provide a skeleton or sample Academy Software Foundation (ASWF) project reflecting the best practices that have been established by the Technical Advisory Committee (TAC). More detailed documentation can be found in the [Technical Advisory Committee repository](https://github.com/AcademySoftwareFoundation/tac). | ||
|
||
## Source Code Repository | ||
|
||
ASWF projects are hosted on GitHub under the [Academy Software Foundation organization](https://github.com/AcademySoftwareFoundation). | ||
|
||
## Licensing | ||
|
||
ASWF projects must chose an explicit open source license, you can use the [Choose a License](https://choosealicense.com/) site to help pick one. Existing projects will typically want to stick to their existing license, as relicensing can be a complicated process. It is preferable to stick with an existing, unmodified, standard open source license since this simplifies the process of getting legal approval for use of the project within commmercial organizations, and allows the use of metadata to identify the project license. | ||
|
||
If you are starting a new project, the ASWF recommends the use of the Apache License 2.0. | ||
|
||
A copy of the license should be in the root directory of your repository and should be called LICENSE. If you are using a standard open source license you should also tag your GitHub project with that license. This can be done at project creation time. | ||
|
||
Source files in your project should use [Software Package Data eXchange (SPDX)](https://spdx.org/) identifiers to specify the project license, for instance in a C++ file: | ||
|
||
// SPDX-License-Identifier: Apache-2.0 | ||
|