-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e76bbc7
commit 9216b3a
Showing
2 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Structure | ||
|
||
## Building | ||
|
||
Clean the build: | ||
``` | ||
./build.sh c | ||
``` | ||
|
||
Build normally: | ||
``` | ||
./build.sh | ||
``` | ||
|
||
Build clean then build normally: | ||
``` | ||
./build.sh a | ||
``` | ||
|
||
## Structure of Output | ||
|
||
Upon running `./main`, it will populate the `zipfiles` directory. | ||
The zipfiles in here will be the generated output from the program. | ||
|
||
Each zip file is put into this directory, but if you want to view | ||
the nested zips, just open `puzzle1.zip` and follow the instructions. | ||
|
||
# Development | ||
|
||
## New Puzzle | ||
|
||
When adding a new puzzle, create a new `puzzle`N directory. Inside of here, | ||
put any files that it needs (ie configuration files, premade files) and prefix | ||
the name of the file with `.`. The `walkdir()` function will ignore any | ||
dotfiles/hidden directories. It will also explore any subdirectories that is inside | ||
of the puzzle directory that you have created. If any of the files are not prefixed with `.`, | ||
then that file will be added to the final zipped version of it. |