You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13-5
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@ _///// as simple as it gets for an image viewer /////_
4
4
5
5
# usage
6
6
7
-
- install the installer from the latest release
8
-
- run it and it'll also add itself to the start menuand context menus (Open with plainIMG)
9
-
- now that it is installed, you can right click over an image, select "Choose another app", "Choose an App on your PC", and find the plainIMG executable at `C:\Users\<your user>\AppData\Local\plainIMG\`, select the executable and click "Always".
7
+
- install the installer from the latest release.
8
+
- run it and it will install the app, and also add plainIMG to start menu. if you click the "Set plainIMG as the default image viewer" option, jpg, jpeg, png and bmp file extensions will be associated with plainIMG.
9
+
- now that it is installed, you can open an image, select plainIMG and click "Always".
10
10
- alternatively, you can go to settings, default apps, and set common image formats to plainIMG.
11
-
- when you are done, you can use plainIMG by using the context menu button in an image
11
+
- when you are done, you can use plainIMG by clicking on the image (or using "Choose an App on your PC")
12
12
- or by running the executable and opening the picture with `Right Click > Open Image...` (or just letter `O`)
13
13
- or by running it through the terminal with first argument being the file path
14
14
- or by dragging a picture over the executable
@@ -36,6 +36,7 @@ to support the developer, you can appreciate the project by giving it a star in
36
36
- quit the app by closing the window, pressing `Q` or `ESCAPE`.
37
37
- the link to this github repository is located inside the `About` menu.
38
38
- WARNING: as of now, this project is only available on Windows. if this project gets enough attention, i will make a version for macOS and possibly even Linux.
39
+
- note: when you click the "Set plainIMG as the default image viewer" option in the installer, it automatically sets plainIMG as default for: .jpg, .jpeg, .png and .bmp; if you want to extend this list, update file extension defaults yourself in windows settings.
39
40
40
41
# screenshots
41
42
@@ -89,7 +90,13 @@ for SDL3_image, there is a special case. copy over the entire SDL folder, where
89
90
then run SDL3_image build with `cmake .. -DBUILD-SHARED-LIBS=OFF`, then do `cmake --build .`.
90
91
you would also need to use `git submodule update --init --recursive` in SDL image.
91
92
92
-
you need inno setup installed to build for release, and it should be in the PATH. to build for release, run `./release.sh <version>`. it will create `build/release`. then, after you made sure that all of the artifacts work, tag the release with `./tag_release.sh <version>`. push it with `git push origin tag <version>`, and then make your release in github. the versions should be in the format of "vX.X.X". **BE SURE TO MANUALLY UPDATE THE VERSION NUMBER IN INSTALLER.ISS BEFORE RUNNING RELEASE.SH**
93
+
if you want to make changes, then make your changes in `dev` branch, and sync them to main with `./sync.sh`.
94
+
when you want to release, switch to `main`.
95
+
96
+
you need inno setup installed to build for release, and it should be in the PATH.
97
+
when you want to build a new release, edit `VERSION.txt` with the version format being `vX.X.X`.
98
+
to build all the things for release, run `./release.sh`. it will create `build/release`, where `build/release/upload` is the things you would need to upload to github release.
99
+
mark your release with `./tag_release.sh`. it will automatically push it. **make sure that you correctly specify the version, and it's not a duplicate**
93
100
94
101
# todo list
95
102
@@ -104,3 +111,4 @@ you need inno setup installed to build for release, and it should be in the PATH
104
111
-[ ] fix the client area dragging being a bit choppy
105
112
-[x] add a global VERSION.txt file which will be used everywhere (main.c, installer.iss, tag_release.sh etc)
106
113
-[ ] add the image basename when an image is opened to the window's title
0 commit comments