Skip to content

Commit 88422d7

Browse files
committed
Add build instructions
1 parent 9bfa629 commit 88422d7

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

.gitattributes

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
*.c text eol=lf
44
*.h text eol=lf
55
*.sh text eol=lf
6+
*.md text eol=lf
7+
8+
.gitignore text eol=lf
9+
.gitattributes text eol=lf

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,20 @@ There are two ways to use this program: either as a typical console program, or
1212

1313
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.
1414

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

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

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

2123
`-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.
24+
25+
## Building
26+
27+
For Windows, simply open the solution in the `vs2022/` folder in **Visual Studio 2022**. Then choose "Release" and build the project!
28+
29+
For Linux, you get a single GCC build script. Have fun.
30+
31+
I didn't want to figure out CMake.

0 commit comments

Comments
 (0)