Update readme
This commit is contained in:
parent
ce935b9a1a
commit
020041680c
1 changed files with 2 additions and 25 deletions
27
README.md
27
README.md
|
@ -1,27 +1,4 @@
|
||||||
# sudoku
|
# sudoku
|
||||||
|
|
||||||
TODO: Write a description here
|
This is a simple Sudoku solver written in [Crystal](https://crystal-lang.org/).
|
||||||
|
It implements a backtracking algorithm.
|
||||||
## Installation
|
|
||||||
|
|
||||||
TODO: Write installation instructions here
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
TODO: Write usage instructions here
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
TODO: Write development instructions here
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
1. Fork it (<https://github.com/your-github-user/sudoku/fork>)
|
|
||||||
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
||||||
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
||||||
4. Push to the branch (`git push origin my-new-feature`)
|
|
||||||
5. Create a new Pull Request
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
- [Alberto Venturini](https://github.com/your-github-user) - creator and maintainer
|
|
Loading…
Add table
Add a link
Reference in a new issue