init

3 files changed, 102 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..5761abc
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+*.o
diff --git a/IDEAS.rst b/IDEAS.rst
new file mode 100644
index 0000000..516800b
--- /dev/null
+++ b/IDEAS.rst
@@ -0,0 +1,64 @@
+************
+Feature list
+************
+
+* Return ratios from all popular image types
+  * JPG
+  * PNG
+  * BMP
+  * etc.
+* Allow image input from multiple sources, such as an image...
+  * On the local file system
+  * From a HTTP or HTTPS web server
+    * Using programs such as ``wget`` or using some random C library
+
+# Possible help message
+::
+
+  uirc: an unecessary image ratio calculator
+  pronounced 'u.i.r.c.' or 'work', does not matter
+
+  Copyright 2022 Bryson Steck
+  Licensed under the GNU General Public License Version 2
+
+  usage: uirc [-uhlr] IMAGE1 [IMAGE2] [...]
+
+  Options:
+    -u  --url         > Mark images as urls.
+                        >> This will cause uirc to make HTTP/HTTPS requests for all the arguments specified instead of using local files. 
+                        >> Links must start with 'http://' or 'https://' before uirc makes any GET requests.
+    -r  --resolution  > Display the resolution of the image
+    -h  --help        > Display this message and exit.
+    -l  --license     > Open the license for uirc
+
+  Help:
+    If you get stuck using uirc, you can read the manpage.
+
+    'man uirc'
+
+Potential output for example commands
+#####################################
+
+::
+
+  $ uirc cool-image.png
+  3:2
+::
+
+  $ uirc one-image.jpg two-image.png red-image.bmp blue-image.jpeg
+  one-image.jpg > 16:9
+  two-image.png > 5:4
+  red-image.bmp > 4:3
+  blue-image.jpeg > 1.24:1
+::
+
+  $ uirc -r 'file with spaces.png'
+  2:3 (2000x3000)
+::
+
+  $ uirc -u https://brysonsteck.net/peter_griffin.png
+  GET https://brysonsteck.net/peter_griffin.png
+  HTTP request returned 200 (OK)
+  Downloading...done
+
+  9:16
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..70f79ca
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,37 @@
+An Unnecessary Image Ratio Calculator
+====================================================
+
+You can either say the acronym ``U I R C`` or, as I've been doing, pronouncing it as ``work``.
+
+What is this?
+-------------
+
+Well, it's an unnecessary image ratio calculator.
+
+It takes an image as an argument in the form of a file on the local file system or a link to an image on a web server, and returns the ratio of the image. That's literally it.
+
+Why does this exist? 
+--------------------
+
+The reason UIRC exists is actually the combination of two events:
+
+1. I've recently started learning more and more about the C programming language, it's history, and how nice and flirty it gets with the actual machine (maybe even making your relationship more serious if you're a psychopath). It runs my OS (Linux) and my window manager (dwm). I use it every day, and it makes me want to learn more and what it can do. Ever since I've been looking for an excuse to make a C program of my own.
+2. I was working at my on-campus job when I needed to know the ratio of an image. Being too lazy to do the math with the image's resolution and oddly hesitant to use a web tool (which I did eventually use), I switched to my terminal quickly to find the file I needed to see what the resolution was, and badda bing badda boom.
+
+Born was my idea. I found an excuse to learn and code in C for an issue that is over-saturated with solutions everywhere.
+
+Why should I use this?
+----------------------
+
+Don't. 
+
+Or you could I guess, I won't stop you. There's just *way* more convenient (and possibly easier for the command-line-illiterate) ways to find the ratio of an image. This is just an idea that I had and the excuse to get me learning how to program in C.
+
+I've made my decision. How do I install?
+----------------------------------------
+
+Ah, the UNIX community. Stubborn about always wanting to use command line tools over convenience. It just warms my heart.
+
+In order to install, you must have ``make`` (installed on basically all \*nix systems) or another compatible tool installed. Then, simply run::
+
+  $ make install