]> Trent Huber's Code - xpmview.git/commitdiff
Update README.md
authorTrent Huber <trentmhuber@gmail.com>
Fri, 14 Feb 2025 20:50:01 +0000 (15:50 -0500)
committerTrent Huber <trentmhuber@gmail.com>
Fri, 14 Feb 2025 20:50:01 +0000 (15:50 -0500)
README.md

index 17c52d9a0b0d69f72e53eb3166de8be0533ac016..ec27e4712fa75f3b21ef3c35d552265696ef653a 100644 (file)
--- 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)