thisiszeev
/
ipuz-to-pdf
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ammended README.md

This commit is contained in:
Ze'ev Schurmann 2024-04-22 17:06:13 +02:00
parent e64fac4401
commit e012e58236
1 changed files with 33 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -10,27 +10,33 @@ This script is for converting ipuz files for crosswords into PDF files as CodeWo
A CodeWord puzzle is a word puzzle where instead of written clues, each letter is replaced with a number. The numbers are filled in across the puzzle in the top left of each corner. Three letters are given (at random) as the starting clues. You then try and solve the puzzles by using logic to work out what letters belong to what numbers.
Usage:
### Usage
```
$ bash codeword-maker {filename}.ipuz
```
Output files are as follows:
### Sample Files for Testing
### CodeWord.{filename}.legendbottom.pdf
cwsample1.ipuz
cwsample2.ipuz
cwsample3.ipuz
### Output Files are as Follows
#### CodeWord.{filename}.legendbottom.pdf
This is an importable version of the puzzle legend for use when layout position is desired for the top or bottom of the puzzle.
### CodeWord.{filename}.legendside.pdf
#### CodeWord.{filename}.legendside.pdf
This is an importable version of the puzzle legend for use when layout position is desired for the side of the puzzle.
### CodeWord.{filename}.puzzle.pdf
#### CodeWord.{filename}.puzzle.pdf
This is an importable version of the actual puzzle. The font has been converted to paths, so you do not need the font installed on the computer used for publishing the puzzle to print.
### CodeWord.{filename}.solution.pdf
#### CodeWord.{filename}.solution.pdf
This is an importable version of the puzzle solution. The font has been converted to paths, so you do not need the font installed on the computer used for publishing the puzzle to print.
@ -40,23 +46,29 @@ This script is for converting ipuz files for crosswords into PDF files.
A CrossWord is a word puzzle, where you are given a blank grid and a set of clues divided into Across and Down. The top or left block for where the word(s) starts in the grid is numbered, and the clues are numbered accordingly. You try and solve the puzzle by using the clues to identifiy the possible word(s), taking into account the amount of squares available for the word(s) and any intersecting letters from other solved words.
Usage:
### Usage
```
$ bash crossword-maker {filename}.ipuz
```
Output files are as follows:
### Sample Files for Testing
### CrossWord.{filename}.clues.txt
cwsample1.ipuz
cwsample2.ipuz
cwsample3.ipuz
### Output Files are as Follows
#### CrossWord.{filename}.clues.txt
This is a text file containing the clues for the puzzle.
### CrossWord.{filename}.puzzle.pdf
#### CrossWord.{filename}.puzzle.pdf
This is an importable version of the actual puzzle. The font has been converted to paths, so you do not need the font installed on the computer used for publishing the puzzle to print.
### CrossWord.{filename}.solution.pdf
#### CrossWord.{filename}.solution.pdf
This is an importable version of the puzzle solution. The font has been converted to paths, so you do not need the font installed on the computer used for publishing the puzzle to print.
@ -66,6 +78,15 @@ Hit me up on Reddit for any requested puzzles to add to future versions.
(u/thisiszeev)[https://reddit.com/u/thisiszeev]
# List of Software that can be Used to Create ipuz Files.
## Linux
- Crosswords : [https://gitlab.gnome.org/jrb/crosswords]
- kSudoku : [https://invent.kde.org/games/ksudoku]
> If you know of any other software that can create ipuz files, please let me know and I will add it here.
# Donations
Please consider making me small donation. Even though my scripts are open source and free to use, I still need to eat. And the occasional bottle of wine also goes down well.
@ -85,4 +106,4 @@ Support is only offered freely to those who donate $20 or more.
Your donation contributes to further development.
If you need a custom script, contact me on Reddit for pricing.
If you need a custom script, contact me on Reddit for pricing.