[Fix #331] Add logo for Flycheck

CHANGES.rst

@@ -3,6 +3,8 @@
 master (in development)
 -----------------------
 
+- #331: Flycheck now has an official logo
+
 - New syntax checkers:
 
   - #393: Go with `errcheck`

Makefile

@@ -3,6 +3,7 @@ EMACSFLAGS =
 CASK = cask
 SPHINX-BUILD = sphinx-build
 SPHINXFLAGS =
+CONVERT = convert
 INSTALL-INFO = install-info
 INSTALL = install
 VERSION := $(shell EMACS=$(EMACS) $(CASK) version)
@@ -19,7 +20,7 @@ BUILDDIR = build
 DOCBUILDDIR = $(BUILDDIR)/doc
 DOCTREEDIR = $(DOCBUILDDIR)/doctrees
 
-.PHONY: compile dist doc html texinfo \
+.PHONY: compile dist doc html texinfo images \
 	clean clean-elc clean-dist clean-doc clean-deps \
 	test \
 	deps linkcheck
@@ -37,6 +38,8 @@ html :
 
 texinfo : doc/flycheck.texi
 
+images: doc/images/logo.png doc/images/favicon.ico # To update the image files
+
 # Test targets
 test : compile
 	$(CASK) exec ert-runner
@@ -81,3 +84,18 @@ $(DOCBUILDDIR)/info/flycheck.texi :
 
 %.elc : %.el $(PKGDIR)
 	$(CASK) exec $(EMACS) -Q --batch $(EMACSFLAGS) -f batch-byte-compile $<
+
+doc/images/favicon.ico: flycheck.svg
+	$(CONVERT) $< -background white \
+		\( -clone 0 -resize 16x16 \) \
+		\( -clone 0 -resize 32x32 \) \
+		\( -clone 0 -resize 48x48 \) \
+		\( -clone 0 -resize 64x64 \) \
+		\( -clone 0 -resize 96x96 \) \
+		\( -clone 0 -resize 196x196 \) \
+		-delete 0 -alpha off -colors 256 $@
+
+doc/images/logo.png: flycheck.svg
+	$(CONVERT) $< -background white \
+		-bordercolor white -border 5 \
+		-trim $@

README.rst

@@ -1,16 +1,18 @@
-==========
- Flycheck
-==========
-
-.. default-role:: code
-
 .. |travis| image:: https://travis-ci.org/flycheck/flycheck.svg?branch=master
             :target: https://travis-ci.org/flycheck/flycheck
 
 .. |license| image:: https://img.shields.io/badge/license-GPL_3-green.svg?dummy
              :target: https://github.com/flycheck/flycheck/blob/master/COPYING
 
-|license| |travis|
+=============================
+ Flycheck |license| |travis|
+=============================
+
+.. image:: https://raw.githubusercontent.com/flycheck/flycheck/logo/doc/images/logo.png
+   :target: http://flycheck.readthedocs.org
+   :align: center
+
+.. default-role:: code
 
 Flycheck is a modern on-the-fly syntax checking extension for GNU Emacs 24,
 intended as replacement for the older Flymake extension which is part of GNU
@@ -135,4 +137,9 @@ under the terms of the Creative Commons Attribution-ShareAlike 4.0 International
 Public License.  A copy of the license can be obtained at
 https://creativecommons.org/licenses/by-sa/4.0/legalcode.
 
+Permission is granted to copy, distribute and/or modify the Flycheck logo in
+``/flycheck.svg`` under the terms of the Creative Commons Attribution-ShareAlike
+4.0 International Public License.  A copy of the license can be obtained at
+https://creativecommons.org/licenses/by-sa/4.0/legalcode.
+
 .. _COPYING: https://github.com/flycheck/flycheck/blob/master/COPYING

doc/conf.py

@@ -75,6 +75,8 @@ linkcheck_ignore = [
 ]
 
 html_title = '{0} {1}'.format(project, release)
+html_logo = 'images/logo.png'
+html_favicon = 'images/favicon.ico'
 
 texinfo_documents = [
   ('index', 'flycheck', 'Flycheck', u'Sebastian Wiesner',

doc/index.rst

@@ -2,6 +2,9 @@
  Flycheck — Modern Emacs syntax checking
 =========================================
 
+.. image:: /images/logo.png
+   :align: center
+
 .. highlight:: cl
 
 Flycheck is a modern on-the-fly syntax checking extension for GNU Emacs 24,
@@ -111,6 +114,11 @@ the terms of the Creative Commons Attribution-ShareAlike 4.0 International
 Public License.  A copy of the license can be obtained at
 https://creativecommons.org/licenses/by-sa/4.0/legalcode.
 
+Permission is granted to copy, distribute and/or modify the Flycheck logo under
+the terms of the Creative Commons Attribution-ShareAlike 4.0 International
+Public License.  A copy of the license can be obtained at
+https://creativecommons.org/licenses/by-sa/4.0/legalcode.
+
 .. toctree::
    :maxdepth: 1
 

flycheck.svg

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   version="1.1"
+   width="256"
+   height="256"
+   id="svg3007">
+  <title
+     id="title3028">Flycheck Logo</title>
+  <defs
+     id="defs3009" />
+  <metadata
+     id="metadata3012">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title>Flycheck Logo</dc:title>
+        <dc:creator>
+          <cc:Agent>
+            <dc:title>Sebastian Wiesner</dc:title>
+          </cc:Agent>
+        </dc:creator>
+        <dc:rights>
+          <cc:Agent>
+            <dc:title>Copyright (C) 2014 Sebastian Wiesner</dc:title>
+          </cc:Agent>
+        </dc:rights>
+        <cc:license
+           rdf:resource="http://creativecommons.org/licenses/by-sa/4.0/" />
+      </cc:Work>
+      <cc:License
+         rdf:about="http://creativecommons.org/licenses/by-sa/3.0/">
+        <cc:permits
+           rdf:resource="http://creativecommons.org/ns#Reproduction" />
+        <cc:permits
+           rdf:resource="http://creativecommons.org/ns#Distribution" />
+        <cc:requires
+           rdf:resource="http://creativecommons.org/ns#Notice" />
+        <cc:requires
+           rdf:resource="http://creativecommons.org/ns#Attribution" />
+        <cc:permits
+           rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
+        <cc:requires
+           rdf:resource="http://creativecommons.org/ns#ShareAlike" />
+      </cc:License>
+    </rdf:RDF>
+  </metadata>
+  <g
+     transform="translate(0,192)"
+     id="layer1">
+    <path
+       d="m 45.347346,-13.742775 3.834571,-3.328834 4.511523,3.328834 4.173046,-3.29785 4.173048,3.29785 4.173047,-3.29785 4.173048,3.29785 3.834571,-3.328834 4.511524,3.328834 4.173046,-3.29785 4.173047,3.29785 4.173051,-3.29785 4.173048,3.29785 3.83456,-3.328834 4.511534,3.328834 4.17305,-3.29785 4.17303,3.29785 4.17306,-3.29785 4.17305,3.29785 3.83457,-3.328834 4.51154,3.328834 4.17304,-3.29785 4.17304,3.29785 4.17304,-3.29785 4.17306,3.29785 4.17304,-3.29785 4.17305,3.29785 4.17305,-3.29785 4.17304,3.29785 4.17304,-3.29785 4.17305,3.29785 3.83459,-3.328834 4.51151,3.328834 4.17305,-3.29785 4.17306,3.29785 4.17303,-3.29785 4.17304,3.29785 3.83457,-3.328834 4.51155,3.328834 4.17303,-3.29785 4.17304,3.29785 4.17306,-3.29785 4.17305,3.29785 3.83456,-3.328834 4.51154,3.328834 4.17304,-3.29785 4.17305,3.29785 4.17305,-3.29785 4.17304,3.29785 3.83456,-3.328834"
+       id="path3923"
+       style="fill:none;stroke:#ff0000;stroke-width:1.77537644;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" />
+    <text
+       x="-11.331055"
+       y="-41.734375"
+       id="text3951"
+       xml:space="preserve"
+       style="font-size:40px;font-style:normal;font-variant:normal;font-weight:300;font-stretch:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Source Code Pro;-inkscape-font-specification:Source Code Pro Light"><tspan
+         x="-11.331055"
+         y="-41.734375"
+         id="tspan3953"
+         style="font-size:100px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:Anonymous Pro;-inkscape-font-specification:Anonymous Pro Bold"><tspan
+   id="tspan3955"
+   style="font-size:100px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;fill:#ff0000;font-family:Anonymous Pro;-inkscape-font-specification:Anonymous Pro Bold">!</tspan>Flyc</tspan></text>
+  </g>
+</svg>