diff --git a/README.md b/README.md index 18aff44..02671cf 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # imcat -Preview any size image in a terminal window. No X11 required. +Preview any size image in a terminal window. ![Sample use](images/sampledesktop.png "Sample use.") +# Platform + +Supports Linux, MacOS and Microsoft Windows 10 terminals. + + ## Introduction Do you ever find yourself logged into a server, over SSH, but there is no X11 connection. @@ -15,9 +20,18 @@ imcat to the rescue! imcat is a 24-bit image viewer that uses ANSI terminal colours to display any image supported by STB. It automatically resizes to the width of your terminal, using proper sampling kernels. +imcat also works on the latest version of Windows 10. + + ## To do * Correct for aspect ratio of terminal font. +## Building + +On linux, just use 'make' to build the imcat binary. + +On Windows, you need clang.exe from Visual Studio 2017 to build the imcat.exe binary. + ## License * Public Domain.