From: Trent Huber Date: Fri, 14 Feb 2025 20:50:01 +0000 (-0500) Subject: Update README.md X-Git-Url: https://trenthuber.com/code?a=commitdiff_plain;h=fdbeff7ddc2ccb7f335e4995f1ae4c90240c773a;p=xpmview.git Update README.md --- diff --git a/README.md b/README.md index 17c52d9..ec27e47 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,22 @@ simplexpm is a simple C program that displays image files that are in the XPM fo ## Building/Running -To build the program, all you need is `git` (which you obviously have if you're cloning this repo) and a C compiler. +To build the program, all you need is a C compiler. ```console $ git clone https://github.com/trenthuber/simplexpm.git $ cd simplexpm $ git submodule update --init -$ cc -o build build.c && ./build +$ cc -o build build.c && ./build && ./bin/simplexpm ``` -This will update all submodules (I use [Raylib](https://www.raylib.com) and my own C build system [cbs](https://github.com/trenthuber/cbs.git)) and then build and run the program. - -To run the program after it's been built, just run the executable found in the `./bin` folder. +This will update the [Raylib](https://www.raylib.com) and [cbs](https://github.com/trenthuber/cbs.git)) submodules, build eveything, and run it. ## Using the program -Simply drag and drop XPM files into the window to view them. The window can be resized and the image will scale accordingly. +Drag and drop XPM files into the window to view them. The window can be resized and the image will scale accordingly. -To reload the current image press `R`. To save the current image as a PNG, press `S`. PNG files are saved to the same folder as the XPM file. +To reload the current image press `r`. To save the current image as a PNG, press `s`. PNG files are saved to the same folder as the XPM file. ## Unimplemented features - Not tested for Linux (built on macOS)