You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@annotator.apache.org by bi...@apache.org on 2020/04/16 15:21:27 UTC

[incubator-annotator] branch master updated: Add validate licensing section for Apache RAT

This is an automated email from the ASF dual-hosted git repository.

bigbluehat pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git


The following commit(s) were added to refs/heads/master by this push:
     new aa5a78b  Add validate licensing section for Apache RAT
aa5a78b is described below

commit aa5a78bd4c64452036477c51f7a2794ebd545f3f
Author: BigBlueHat <by...@bigbluehat.com>
AuthorDate: Thu Apr 16 11:21:19 2020 -0400

    Add validate licensing section for Apache RAT
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 1666ee1..5159e74 100644
--- a/README.md
+++ b/README.md
@@ -100,6 +100,17 @@ Invalid:
 
 Apache License 2.0
 
+#### Validate Licensing
+
+[Apache Rat (Release Audit Tool)](https://creadur.apache.org/rat/) is a
+preferred code license checking tool used by [the ASF](https://apache.org/).
+The included `.ratignore` file contains a list of files to exclude from scans.
+
+To check for included licenses, run the following and view the output report:
+```sh
+java -jar ~/bin/apache-rat-0.13/apache-rat-0.13.jar -E .ratignore -d . > rat_report.txt
+```
+
 # Disclaimer
 
 Apache Annotator is currently undergoing incubation at The Apache Software