Skip to content

Commit

Permalink
Create Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
vikman90 committed Feb 23, 2024
1 parent ccd1142 commit 732776a
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# N Queens Problem Solver

[![CI](https://github.com/vikman90/queens-psr/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/vikman90/queens-psr/actions/workflows/ci.yml)

This is a set of implementations of the famous N Queens Problem solver in
multiple programming languages. The N Queens Problem is a problem of placing N
queens on an NxN chessboard without any queen being able to attack the others.

## Features

- Efficient implementations.
- Utilize backtracking and constraint propagation to find a solution.
- Provides the ability to specify the number of queens (size of the board).
- Offers an alternative testing output of the found solutions.

## Requirements

|Implementation|Ubuntu packages|
|--|--|
|C++|g++ make|
|C#|dotnet-sdk-8.0|
|Go|golang|
|Java|openjdk-19-jdk-headless|
|JavaScript|nodejs|
|PHP|php|
|Python|python3|
|Rust|cargo|

## Usage

Instructions available at each implementation folder.

## Contribution

Contributions are welcome! If you have any ideas to improve this project, feel free to submit a pull request.

## Credits

This project was developed by [Vikman Fernandez-Castro](https://github.com/vikman90).

## License

This project is licensed under the MIT License.

0 comments on commit 732776a

Please sign in to comment.