Skip to content

Commit

Permalink
Add build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Elletra committed Nov 19, 2023
1 parent 9bfa629 commit 88422d7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
*.c text eol=lf
*.h text eol=lf
*.sh text eol=lf
*.md text eol=lf

.gitignore text eol=lf
.gitattributes text eol=lf
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,20 @@ There are two ways to use this program: either as a typical console program, or

To use it normally, just drag an image file onto the program and select your orientation. Make sure there's a `colorSet.txt` file in the same directory as the program.

***

You can also use it as a command-line program: `image2brick (-v | -h) [-c colorset_file] [-X] image_file`

`-v` and `-h` options are the orientation that the macro will be in. The program requires you to specify at least one.

`-c` specifies the colorset file to use. If not specified, image2brick will look for `colorSet.txt` in the current working directory.

`-X` makes the program behave as a command-line interface. Since the vast majority of users of this program will use Windows, it operates as a normal program by default, pausing after messages and making the user select an orientation if one wasn't specified in the arguments. This option disables that and will simply display error/success messages and then immediately exit.

## Building

For Windows, simply open the solution in the `vs2022/` folder in **Visual Studio 2022**. Then choose "Release" and build the project!

For Linux, you get a single GCC build script. Have fun.

I didn't want to figure out CMake.

0 comments on commit 88422d7

Please sign in to comment.