Skip to content

Commit

Permalink
Add logo images to repository
Browse files Browse the repository at this point in the history
This closes #29.

For the time being not many changes are introduced in the docs, just the
logos being uploaded.

In the near feature, when #17 and #18 are addressed, we might do a
better use of it.
  • Loading branch information
abravalheri committed Jun 14, 2021
1 parent 24b352b commit 1c2d235
Show file tree
Hide file tree
Showing 12 changed files with 672 additions and 8 deletions.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,16 @@
:alt: Monthly Downloads
:target: https://pepy.tech/project/configupdater

=============
ConfigUpdater
=============
|
.. image:: https://configupdater.readthedocs.io/en/latest/_latest/banner-640x323.png
:height: 640px
:width: 323px
:scale: 60 %
:alt: Config Updater
:align: center

|
The sole purpose of `ConfigUpdater`_ is to easily update an INI config file
with no changes to the original file except the intended ones. This means
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,12 +181,12 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = ""
# html_logo = "gfx/configupdater-254x128.png"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None
html_favicon = "gfx/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
19 changes: 19 additions & 0 deletions docs/gfx/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
The logo design uses the Monoid typeface a open source webfont that was
developed by Andreas Larsen and contributors in 2015 under the MIT or SIL
licenses.
More information at https://github.com/larsenwork/monoid

The colors include pure black (`#000000`), pure white (`#FFFFFF`), 30% gray for the
box shadow (`#B3B3B3`) and an accent color (`#008C70`) that can be understood as a
tone of "teal"

A vector representation of the design can be found in the files:

- `configupdater.svg`: produced with [Inkscape](https://inkscape.org/), might
contain specific markup not understood by other software. This file
should be preferred when using Inkscape.
- `configupdater_plain.svg`: a "plain" version of the same file that in theory
should not contain inkscape-specific markup. This file might be preferred
when using other editors.
- `icon.svg`: another Inkscape file that only contains, this time without the
"ConfigUpdater" name, just the icon image.
Binary file added docs/gfx/banner-1280x645.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gfx/banner-640x323.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
306 changes: 306 additions & 0 deletions docs/gfx/configupdater.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1c2d235

Please sign in to comment.