close spotbugs#18: add README.md to describe where the source of manu…

…al exists
KengoTODA · Jul 16, 2017 · 8527e44 · 8527e44
1 parent 0371da7
commit 8527e44
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+SpotBugs GitHub pages
+=====================
+
+This repository hosts following pages:
+
+* [GitHub homepage](https://spotbugs.github.io/)
+* [Update site for SpotBugs Eclipse plugin (stable)](https://spotbugs.github.io/eclipse/)
+* [Update site for SpotBugs Eclipse plugin (candidate)](https://spotbugs.github.io/eclipse-candidate/)
+
+Note that source code for [SpotBugs manual](https://spotbugs.readthedocs.io/en/latest/) is hosted at [the docs directory in spotbugs repository](https://github.com/spotbugs/spotbugs/tree/master/docs).