]> Trent Huber's Code - xpmview.git/commitdiff
Trailing slashes consistency in README.md
authorTrent Huber <trentmhuber@gmail.com>
Sat, 23 Aug 2025 06:36:31 +0000 (02:36 -0400)
committerTrent Huber <trentmhuber@gmail.com>
Sat, 23 Aug 2025 06:36:31 +0000 (02:36 -0400)
README.md

index 2a7f7c01714d3b1154980eefecdfe19b38410b07..9b3347107a042ee5ba9a396224262aaedbda645f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,37 +5,37 @@ simplexpm is a simple GUI application used to view XPM image files.
 ## Building
 
 > [!NOTE]
-> If building on Linux, [Raylib](https://github.com/raysan5/raylib) has been configured to use X11. If you don't have X11 installed, you can either install the necessary X11 packages or change the `CFGRAPHICS` [macro](https://github.com/raysan5/raylib/blob/282d6478baa51a509bf0a4b1d761a0bd7fd8bbf7/src/rglfw.c#L32) in `external/build.c` to use Wayland instead.
+> If building on Linux, [Raylib](https://github.com/raysan5/raylib/) has been configured to use X11. If you don't have X11 installed, you can either install the necessary X11 packages or change the `CFGRAPHICS` [macro](https://github.com/raysan5/raylib/blob/282d6478baa51a509bf0a4b1d761a0bd7fd8bbf7/src/rglfw.c#L32) in `external/build.c` to use Wayland instead.
 
 This repository uses submodules, so you'll need to clone it recursively.
 
 ```console
-$ git clone --recursive https://github.com/trenthuber/simplexpm
-$ cd simplexpm
+> git clone --recursive https://github.com/trenthuber/simplexpm/
+> cd simplexpm/
 ```
 
-simplexpm uses [cbs](https://github.com/trenthuber/cbs) as its build system. cbs uses C source code as its build files, so the only thing you need to build this project is a C compiler. The first step is to bootstrap the build system by compiling the build file located at the root level of the repository.
+simplexpm uses [cbs](https://github.com/trenthuber/cbs/) as its build system. cbs uses C source code as its build files, so the only thing you need to build this project is a C compiler. The first step is to bootstrap the build system by compiling the build file located at the root level of the repository.
 
 ```console
-$ cc -o build build.c
+> cc -o build build.c
 ```
 
 Running the `build` executable we just generated will build the entire project.
 
 ```console
-$ ./build
+build
 ```
 
 Once built, the application will be located in the `bin/` folder.
 
 ```console
-$ ./bin/simplexpm
+bin/simplexpm
 ```
 
 To clean the repository after building, just run the `clean` executable generated by the build system.
 
 ```console
-$ ./clean
+clean
 ```
 
 The `clean` executable doesn't remove the root `build` executable, so you can always rebuild the project without having to bootstrap again.
@@ -51,7 +51,7 @@ If modifications are made to the XPM file while loaded, hitting `r` reloads the
 Finally, with an XPM file loaded, color modes can be changed by pressing corresponding keys (see a complete list of key bindings by using the `-h` flag).
 
 ```console
-$ ./bin/simplexpm -f assets/test.xpm
+bin/simplexpm -f assets/test.xpm
 ```
 ![Here's an image of the above command running on my machine.](assets/application.png "Running the above command")