The C-based comics downloader
Explore the docs »

Submit A Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License

About The Project

Built With

• gnu99-C
• ncurses
• libcurl
• SQLite
• GNU Autotools

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To install cmics, only a few dependencies are required. Get the following packages with pip and your package manager of choice.

• pip

pip3 install -r requirements.txt

• Package manager (Debian/Ubuntu example)

sudo apt-get install libncurses5-dev libncursesw5-dev 
sudo apt-get install libcurl4-gnutls-dev

Installation

cmics is maintained using the GNU Autotools. To install, clone and make the build system yourself (autoreconf --install), or download a tarball, unzip it, and follow the ritual:

./configure
make
sudo make install

WARNING: If you want to install cmics somewhere else, that's totally fine. However, modify src/imgs.c so that the path of the installed img script is correct. If this is ommitted, the comics will download and cache correctly, but they will not display properly.

Usage

Cmics is used for aggregating some of the geekier comics that many members of the programming community enjoy. To automate downloading all of the comics, you can set up a cron job of cmics --download .... cmics logs all comics image URLs in an sqlite database, accessable with cmics -a or --archive. It logs the time accessed, comic, and the absolute image url, so that if you remember, "There was this great XKCD I read last thursday... what was it?" You could so something like cmics -a | grep 'Comic: xkcd' -B 2 and get all of the XKCD images that cmics has downloaded. The database is found in $HOME/.comics/cmics.db.

Roadmap

Some things I intend to add one day are:

• Another comic (or two). This is limited by keeping the GUI useable for people with small terminals, however.
• A more sophisticated image display mechanism than the img script.

Bugs

There are no currently known bugs in cmics. If you find a bug, please open an issue on GitHub!

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the 3-part BSD License. See LICENSE for more information.