Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mmsbrggr/hsudoku

A native gtk sudoku game written in haskell
https://github.com/mmsbrggr/hsudoku

game gtk3 haskell haskell-gi sudoku

Last synced: about 1 month ago
JSON representation

A native gtk sudoku game written in haskell

Host: GitHub
URL: https://github.com/mmsbrggr/hsudoku
Owner: mmsbrggr
License: mit
Created: 2017-04-03T11:57:47.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2017-05-29T11:31:39.000Z (over 7 years ago)
Last Synced: 2024-10-28T14:16:47.263Z (2 months ago)
Topics: game, gtk3, haskell, haskell-gi, sudoku
Language: Haskell
Homepage:
Size: 801 KB
Stars: 33
Watchers: 5
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# λsudoku

[![Travis](https://img.shields.io/travis/mmsbrggr/hsudoku.svg)](https://travis-ci.org/mmsbrggr/hsudoku)
[![GitHub issues](https://img.shields.io/github/issues/mmsbrggr/hsudoku.svg)](https://github.com/mmsbrggr/hsudoku/issues)
[![GitHub stars](https://img.shields.io/github/stars/mmsbrggr/hsudoku.svg)](https://github.com/mmsbrggr/hsudoku/stargazers)
![GTK version](https://img.shields.io/badge/GTK-3.20-blue.svg)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/mmsbrggr/hsudoku/master/LICENSE)

-------

Appearance •
Motivation •
Installation •
Usage •
Tests •
Documentation

-------

## Appearance

## Motivation
λsudoku was born in a haskell universty course at the technical university in Vienna.
The goal was to create a neat looking and user-friendly haskell game using modern technologies and libraries, namely GTK3 and [haskell-gi](https://github.com/haskell-gi/haskell-gi).
The sudokus get loaded from the internet, parsed in haskell and made playable through a native gtk interface.
Special thank goes to [Kjell Ericson](https://kjell.haxx.se/sudoku/) for letting me use is [sudoku generator web-app](https://kjell.haxx.se/sudoku/).

## Installation
λsudoku has a few prerequesites. If they are already installed on your system, you can skip the following steps.
- At least GHC 8.0.2 and cabal 1.24
```
sudo add-apt-repository -y ppa:hvr/ghc
sudo apt-get update
sudo apt-get install cabal-install-1.24 ghc-8.0.2
export PATH=/opt/ghc/8.0.2/bin:/opt/cabal/1.24/bin:$PATH
```
- GTK+3.20 and other packages needed for the UI
```
sudo add-apt-repository ppa:gnome3-team/gnome3-staging
sudo apt-get update
sudo apt-get install build-essential libgtk-3-dev libgirepository1.0-dev libcairo2-dev libgdk-pixbuf2.0-dev
```
- The *happy* haskell package
```
cabal update
cabal install happy
```

With all dependencies in place, the hsudoku game can be installed:
```
git clone [email protected]:marcelmoosbrugger/hsudoku.git
cd hsudoku
cabal install --only-dependencies
cabal build
```

## Usage
If everything is installed the game can be run from the installation folder:
```
dist/build/hsudoku/hsudoku
```

## Tests and Coverage
Tests can easily be run with:
```
cabal test
```

## Documentation
Documentation of the code and the hackage package can be found on [hackage/hsudoku](https://hackage.haskell.org/package/hsudoku)

## Licence
This project is licensed under the terms of the MIT license. See the LICENSE file.