Skip to content

Commit 4d7d369

Browse files
committed
Update Readme.md.
Finish documentation.
1 parent 6c10437 commit 4d7d369

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

Readme.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,26 @@ Note: This web page does not save any entered clues or values. Refreshing or nav
1414

1515
###Instructions:
1616
1. To begin, __enter some clues__. Find a sudoku puzzle and input its clues using the number keys to insert values. The arrow keys, TAB, and ENTER can be used for navigation, while DELETE and BACKSPACE remove values. Alternatively enter clues using the Paste puzzle button.
17-
2. __Submit the clues__ by clicking the Submit clues button. This sets the clues as read-only and enables several features.
17+
2. __Submit the clues__ by clicking the Submit clues button. Sets the clues as read-only and enables several features.
1818
3. __Solve the puzzle__ using pencil marks, cell highlighting, guesses, hints, and if all else fails, show solution.
1919

2020
###Button descriptions:
21-
* __Clear cells__: Deletes all clues and values, resets pencil marks, and removes all highlighting. This resets the page to its initial state.
22-
* __Submit clues__: Marks the entered values as read-only clues and submits them to the puzzle solver. Also enables hints, show solution, and guess removal. Once the clues have been submitted, they cannot be changed.
23-
* __Paste puzzle__: Allows values to be inputted from the clipboard. This overwrites existing values. Zeros can be used as placeholders for empty cells. Characters other than 0-9 are ignored. There must be exactly 81 numbers for this to work properly.
21+
* __Clear cells__: Deletes all clues and values, resets pencil marks, and removes all highlighting. Use carefully, this resets the page to its initial state.
22+
* __Submit clues__: Sets the entered values as read-only clues and submits them to the puzzle solver. Once the clues have been submitted, they cannot be changed. This generates a solution for the clues and as a result, enables hints, show solution, and guess removal.
23+
* __Paste puzzle__: Allows values to be inputted from the clipboard. Use carefully, this overwrites existing values. Zeros can be used as placeholders for empty cells. Characters other than 0-9 are ignored. There must be exactly 81 numbers for this to work properly.
24+
2425
* __1-9__: Highlights all cells that do not have a pencil mark of 1-9 a pale green color. If the pencil marks are updated, this can be used to easily determine which cells do not have a value of 1-9. Does not update automatically.
2526
* __Clear__: Removes all cell highlighting.
2627

27-
* __Reset__: THIS CAN BE USED IF YOU DO NOT WANT TO HAVE THE HELP OF PENCIL MARKS.
28+
* __Enter values__: When this option is selected, typing a number in a cell changes its value.
29+
* __Enter pencil marks__: When this option is selected, typing a number in a cell toggles that pencil mark.
30+
* __Automatically remove pencil marks__: When this option is enabled, entering a value in a cell removes that pencil mark from all of the cell's neighbors (cells in the same row, box, or column).
31+
* __Update__: Changes all pencil marks so that they show the possible values that each cell could have. Use carefully, this overwrites existing pencil marks.
32+
* __Reset__: Adds all pencil marks to empty cells. Allows solving the puzzle without the aid of pencil marks. Use carefully, this overwrites existing pencil marks.
33+
* __Show duplicates__: When this option is enabled, neighboring cells with the same value are flagged red.
34+
35+
* __Mark blank cells `color`__: Marks all blank cells with a certain color. Use this to make guesses so that if the guess is incorrect, all values entered afterwards can be removed easily.
36+
* __Delete cells marked `color`__: Deletes all cells that have been marked a certain color. Does not affect cells marked a different color or pencil marks.
37+
38+
* __Show solution__: Shows the solution for the clues, or a solution if there are more than one.
39+
* __Hint__: Gives a hint for cell that was last selected, up to three hints. Hints are based on the solution.

index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,17 +81,17 @@
8181
<div class="small_header">Guessing tools:</div>
8282
<ul>
8383
<li>
84-
Set blank cells:
85-
<select title="Set the blank cells a unique color so they can be deleted easily. This is useful for making guesses." onchange="this.style.color = this.value.toLowerCase(); setBlankCells(this.value.toLowerCase());">
84+
Mark blank cells:
85+
<select title="Mark all blank cells a unique color so they can be deleted easily. This is useful for making guesses." onchange="this.style.color = this.value.toLowerCase(); setBlankCells(this.value.toLowerCase());">
8686
<option selected="selected" style="color: black;">Black</option>
8787
<option style="color: blue;">Blue</option>
8888
<option style="color: red;">Red</option>
8989
<option style="color: green;">Green</option>
9090
<option style="color: purple;">Purple</option>
9191
</select>
9292
</li><li>
93-
Delete cells highlighted:
94-
<select title="Delete all cells of a certain color." onchange="deleteColoredCells(this);">
93+
Delete cells marked:
94+
<select title="Delete all cells marked a certain color." onchange="deleteColoredCells(this);">
9595
<option selected="selected">Select Color</option>
9696
<option style="color: blue;">Blue</option>
9797
<option style="color: red;">Red</option>

0 commit comments

Comments
 (0)