Skip to content

Commit faeebd0

Browse files
committed
Finish renaming the application prior to renaming the GitHub repository
Finally settled on the name `ficonic`, which kind of means that it's an application related to ficons, where "ficon" is a smooshed form of "favicon" and also a structure in that program that contains a favicon's image and other data.
1 parent b5b0d3b commit faeebd0

File tree

6 files changed

+140
-133
lines changed

6 files changed

+140
-133
lines changed

Makefile.am

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
AUTOMAKE_OPTIONS = subdir-objects
22

3-
bin_PROGRAMS = FaviconGofer
3+
bin_PROGRAMS = ficonic
44

5-
FaviconGofer_SOURCES = \
5+
ficonic_SOURCES = \
66
src/Curler.cpp \
77
src/Curler.h \
88
src/main.cpp \
@@ -16,9 +16,9 @@ FaviconGofer_SOURCES = \
1616
src/LinkIconsRetriever.cpp \
1717
src/LinkIconsRetriever.hpp
1818

19-
FaviconGofer_CPPFLAGS = \
19+
ficonic_CPPFLAGS = \
2020
-I/usr/include/ImageMagick-6 \
2121
-I/usr/include/htmlcxx/html
2222

23-
FaviconGofer_LDFLAGS = \
23+
ficonic_LDFLAGS = \
2424
`Magick++-config --cppflags --cxxflags --ldflags --libs`

Makefile.in

Lines changed: 107 additions & 109 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
1-
# FaviconGofer
2-
Utility to retrieve favicons for a given URL
1+
# ficonic
2+
Utility for retrieving favicons and other site-related icons for a given URL
33

4-
This utility currently only provides icons based on files stored in a site's root directory where those files exist. A site's `favicon.ico` file is retrieved, split into its constituent icon images, and each icon image is provided in both BMP and PNG formats. A site's `apple-touch-icon.png` file is also retrieved and stored. The resultant image files are stored in a user specified directory.
4+
## Description
5+
The purpose of _ficonic_ is to download all icons intended for use in identifying a site at a given URL. This allows the user to select the icon best suited for the medium through which they intend to identify the site.
56

6-
If desired, the retrieved `favicon.ico` file from the last run of the application may be recovered from the system's temporary directory (currently assumed to be `/tmp`; that needs to be fixed...) until the directory is cleared by the system.
7+
_ficonic_ downloads `favicon.ico` and `apple-touch-icon.png` files where found in the site's root directory and any icons identified in HTML `link` tags having recognized `rel` values. Any properly formatted `.ico` files are split into their contained icons and saved in as both `.bmp` and `.png` format files. Therefore, if a `.ico` file contains three different sized icons, for example, _ficonic_ will save six icons for the one file: three `.bmp` files and three `.png` files. An attempt is made to determine the actual format of an improperly formatted `.ico` file, e.g. where a `.png` file has simply been renamed `favicon.ico`; if successful, the icon is saved in that format with the proper extension.
78

8-
Run `FaviconGofer -h` for usage information.
9+
The downloaded icons are saved to a user-specified directory. While their contained icons are saved, `.ico` files themselves are not currently saved.
10+
11+
If desired, the retrieved `favicon.ico` file from the last run of the application may be recovered from the system's temporary directory (currently assumed to be `/tmp`) until the directory is cleared by the system.
12+
13+
Run `ficonic -h` for usage information.
914

1015
## Dependencies
1116
The following libraries are required:
@@ -15,4 +20,8 @@ The following libraries are required:
1520
* Magick++ version 6 (C++ Bindings library for ImageMagick)
1621
* htmlcxx
1722

18-
Note: Magick++ for GraphicsMagick _**may**_ work but has not been tested. If you should happen to test it, please post an Issue describing your experience so I can refer to the information here, giving you credit of course. _Thanks!_
23+
## To Do
24+
* Properly obtain the path to a system's temporary directory.
25+
* Save `.ico` files along with icon files.
26+
* Handle HTML `meta` tags referring to Microsoft tiles.
27+
* Handle Progressive Web App manifests referring to icons.

configure

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

configure.ac

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Process this file with autoconf to produce a configure script.
33

44
AC_PREREQ([2.71])
5-
AC_INIT([FaviconGofer], [0.0.1], [])
5+
AC_INIT([ficonic], [0.0.1], [])
66
AC_CONFIG_SRCDIR([src/Curler.h])
77
AC_CONFIG_HEADERS([config.h])
88
AM_INIT_AUTOMAKE([-Wall -Werror foreign])

src/program_info.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@
3030
#ifndef SRC_PROGRAM_INFO_H_
3131
#define SRC_PROGRAM_INFO_H_
3232

33-
#define PROGNAME "Ficonic"
33+
#define PROGNAME "ficonic"
3434

3535
#endif /* SRC_PROGRAM_INFO_H_ */

0 commit comments

Comments
 (0)