new readme

README.md

@@ -1,57 +1,92 @@
+# tview
+>  A (relatively) fast, lightweight, and useful image viewer.
 
-# How to Build
+![[main.png]]
 
-## Windows with Visual Studio's IDE
+# Features
+- Supports most common image formats
+- EXIF Viewing
+- Histogram Calculation
+- Toggle image filtering
+- Pixel level details
+- Color tooltip
+# Gallery
+## Tooltip
+Toggle the tooltip by pressing `t`
+![[tooltip.png]]
+## Detail Views
+Toggle detail modes by pressing `d`
 
-Use the provided project file (.vcxproj). Add to solution (imgui_examples.sln) if necessary.
+| Normal Arrow          | Hex Color           | RGB 255 Color           | RGB Float Color           |
+| --------------------- | ------------------- | ----------------------- | ------------------------- |
+| ![[detail_arrow.png]] | ![[detail_hex.png]] | ![[detail_rgb_int.png]] | ![[detail_rgb_float.png]] |
+## Image Filtering
+Toggle Filtering by pressing 
 
-## Windows with Visual Studio's CLI
+| Filtering Off          | Filtering On          |
+| ---------------------- | --------------------- |
+| ![[filtering_off.png]] | ![[filtering_on.png]] |
+# Usage
+`tview PATH/TO/IMAGE`
 
-Use build_win32.bat or directly:
+Press `h` to show the help dialog within the program.
+## Mouse
+Scroll to zoom.
+Click and drag to pan.
+
+## Keyboard
+- `h` - Show help
+- `c`- Toggle Histogram
+- `e`- Toggle EXIF data
+- `d`- Cycle [[#Detail Views]] (default off)
+- `a` - Toggle image filtering (default off)
+- `g` - Toggle grid (only visible at pixel level)
+- `r`- Rotate image 90 degrees clockwise
+- `q` - Quit
+
+# Installing
+## Requirements to Run
+- SDL2
+- OpenGL
+- Libexiv2
+
+## Requirements to build
+In addition to the run requirements
+- CMake
+- C++ Compiler (g++/clang++)
+### On Ubuntu
 ```
-set SDL2_DIR=path_to_your_sdl2_folder
+apt install --no-install-recommends build-essential cmake libsdl2-dev libexiv2-dev mesa-utils
-cl /Zi /MD /utf-8 /I.. /I..\.. /I%SDL2_DIR%\include main.cpp ..\..\backends\imgui_impl_sdl2.cpp ..\..\backends\imgui_impl_opengl3.cpp ..\..\imgui*.cpp /FeDebug/example_sdl2_opengl3.exe /FoDebug/ /link /libpath:%SDL2_DIR%\lib\x86 SDL2.lib SDL2main.lib opengl32.lib /subsystem:console
+```
-#                 ^^ include paths                  ^^ source files                                                                                    ^^ output exe                    ^^ output dir   ^^ libraries
+### On Debian
-# or for 64-bit:
+```
-cl /Zi /MD /utf-8 /I.. /I..\.. /I%SDL2_DIR%\include main.cpp ..\..\backends\imgui_impl_sdl2.cpp ..\..\backends\imgui_impl_opengl3.cpp ..\..\imgui*.cpp /FeDebug/example_sdl2_opengl3.exe /FoDebug/ /link /libpath:%SDL2_DIR%\lib\x64 SDL2.lib SDL2main.lib opengl32.lib /subsystem:console
+apt install --no-install-recommends build-essential cmake libsdl2-dev libexiv2-dev mesa-utils
+```
+### On Arch
+```
+pacman -Sy sdl2 mesa-utils exiv2 cmake base-devel
 ```
 
-## Linux and similar Unixes
+## Building
-
+Clone the repository
-Use our Makefile or directly:
 ```
-c++ `sdl2-config --cflags` -I .. -I ../.. -I ../../backends
+git clone https://git.dws.rip/dubey/tview.git
-  main.cpp ../../backends/imgui_impl_sdl2.cpp ../../backends/imgui_impl_opengl3.cpp ../../imgui*.cpp
-  `sdl2-config --libs` -lGL -ldl
 ```
 
-## macOS
+Change directory into the repository
-
-Use our Makefile or directly:
 ```
-brew install sdl2
+cd tview
-c++ `sdl2-config --cflags` -I .. -I ../.. -I ../../backends
-  main.cpp ../../backends/imgui_impl_sdl2.cpp ../../backends/imgui_impl_opengl3.cpp ../../imgui*.cpp
-  `sdl2-config --libs` -framework OpenGl -framework CoreFoundation
 ```
 
-## Emscripten
+Generate build files and trigger build
+```
+cmake .
+cmake --build .
+```
 
-**Building**
+You will now have a file called `tview` in the repository root, you can copy this into your path:
+```
+sudo mv ./tview /usr/local/bin/tview
+```
 
-You need to install Emscripten from https://emscripten.org/docs/getting_started/downloads.html, and have the environment variables set, as described in https://emscripten.org/docs/getting_started/downloads.html#installation-instructions
+`tview` is now installed on your system
-
-- Depending on your configuration, in Windows you may need to run `emsdk/emsdk_env.bat` in your console to access the Emscripten command-line tools.
-- You may also refer to our [Continuous Integration setup](https://github.com/ocornut/imgui/tree/master/.github/workflows) for Emscripten setup.
-- Then build using `make -f Makefile.emscripten` while in the current directory.
-
-**Running an Emscripten project**
-
-To run on a local machine:
-- `make -f Makefile.emscripten serve` will use Python3 to spawn a local webserver, you can then browse http://localhost:8000 to access your build.
-- Otherwise, generally you will need a local webserver. Quoting [https://emscripten.org/docs/getting_started](https://emscripten.org/docs/getting_started/Tutorial.html#generating-html):<br>
-_"Unfortunately several browsers (including Chrome, Safari, and Internet Explorer) do not support file:// [XHR](https://emscripten.org/docs/site/glossary.html#term-xhr) requests, and can’t load extra files needed by the HTML (like a .wasm file, or packaged file data as mentioned lower down). For these browsers you’ll need to serve the files using a [local webserver](https://emscripten.org/docs/getting_started/FAQ.html#faq-local-webserver) and then open http://localhost:8000/hello.html."_
-- Emscripten SDK has a handy `emrun` command: `emrun web/index.html --browser firefox` which will spawn a temporary local webserver (in Firefox). See https://emscripten.org/docs/compiling/Running-html-files-with-emrun.html for details.
-- You may use Python 3 builtin webserver: `python -m http.server -d web` (this is what `make serve` uses).
-- You may use Python 2 builtin webserver: `cd web && python -m SimpleHTTPServer`.
-- If you are accessing the files over a network, certain browsers, such as Firefox, will restrict Gamepad API access to secure contexts only (e.g. https only).