catmeow/bmxconverter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Zachary Hall 2023-11-17 12:32:38 -08:00 committed by GitHub
parent b412d4c279
commit af10d2fb3c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -5,11 +5,11 @@ A converter to/from the B16/BMX bitmap format being developed for the Commander
This program requires ImageMagick, and Magick++ (which may come with ImageMagick) This program requires ImageMagick, and Magick++ (which may come with ImageMagick)
Steps: Steps:
1. Clone the repo 1. Clone the repo. For example: ``git clone https://github.com/catmeow72/b16converter.git b16converter``
2. cd into the repo directory 2. cd into the repo directory. For example: ``cd b16converter``
3. Run meson setup builddir 3. Run ``meson setup builddir``
4. Run meson compile -C builddir 4. Run ``meson compile -C builddir``
5. The binary is (Repo directory)/builddir/b16converter(.exe) 5. The binary is ./builddir/b16converter(.exe) where (.exe) is .exe if on Windows, and nothing on other operating systems.
## Usage ## Usage
Run the binary with the -in option specifying the input file and the -out option specifying the desired output file. Run the binary with the -in option specifying the input file and the -out option specifying the desired output file.
@ -21,4 +21,4 @@ Check the flags with -help
## Testing ## Testing
Use the test.sh script from an environment with Bash available to automatically convert PACK.png and TEST.png to B16 at various resolutions and bitdepths, with and without dithering. It also converts back to PNG from the B16 files to test that functionality. Use the test.sh script from an environment with Bash available to automatically convert PACK.png and TEST.png to B16 at various resolutions and bitdepths, with and without dithering. It also converts back to PNG from the B16 files to test that functionality.
Once you have .b16 files, you can test it with my B16 viewer inside the X16 emulator. Once you have .b16 files, you can test it with my B16 viewer inside the X16 emulator.