Installation Guide - dclamage/SudokuSolver GitHub Wiki

Installation Guide

SudokuSolver is a set of portable files which require no installation. You will need a rudimentary understanding of what zip files are and how to extract them to a memorable location.

Initial Setup

  1. Download the latest stable release of SudokuSolver for your platform.
  2. Create a directory for the solver and extract all the files there.

Using with f-puzzles

See Using f-puzzles.com Integration for instructions to integrate with f-puzzles. The instructions below are to run the solver in a standalone way without f-puzzles.

Running the Program (Windows)

SudokuSolver is a command-line application, and it is out of scope of this document to teach you how to use the command-line tools for your operating system. You will need a rudimentary understanding of what a command window or terminal is, how to change directories within it, and how to run programs which are the in the current directory with command-line options. If you only want to use the f-puzzles integration, see the section above.

  1. Open a command window by opening the start menu and typing cmd and pressing enter.
  2. Change directory to where you extracted the zip file.
  3. Type the following command:
SudokuSolverConsole
  1. You should see a banner appear and it should enter listen mode (for f-puzzles.com Integration).

Running the Program (OSX / Linux)

  1. Open a terminal
  2. Change directory to where you installed the dmg file.
  3. Type the following command:
./SudokuSolverConsole
  1. You should see a banner appear and it should enter listen mode (for f-puzzles.com Integration).
  2. If you get a "Permission denied" error, then type the following command and try again:
chmod +x SudokuSolverConsole

Updating

  1. To update to a new release, it is recommended to extract the files to a new directory. Once confirming the new release works for you, you can delete your old directory. (Unless, of course, you have file saved there that you'd like to keep).
    • NOTE: Extracting into the existing directory and replacing all files should work, but may cause issues if old files remain which are no longer used.
  2. If using the f-puzzles.com Integration, remember to update your user script as well.
  3. Join the Discord server to receive notifications about new releases.

What next