-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c40ce7c
commit b7c22ac
Showing
1 changed file
with
153 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,160 @@ | ||
| # eight_queens | ||
| <!-- | ||
| *** Thanks for checking out this README Template. If you have a suggestion that would | ||
| *** make this better, please fork the repo and create a pull request or simply open | ||
| *** an issue with the tag "enhancement". | ||
| *** Thanks again! Now go create something AMAZING! :D | ||
| *** | ||
| *** | ||
| *** | ||
| *** To avoid retyping too much info. Do a search and replace for the following: | ||
| *** github_username, repo, twitter_handle, email | ||
| --> | ||
|
|
||
| Eight Queens Simple App | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <!-- PROJECT SHIELDS --> | ||
| <!-- | ||
| *** I'm using markdown "reference style" links for readability. | ||
| *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
| *** See the bottom of this document for the declaration of the reference variables | ||
| *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
| *** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
| --> | ||
| [![Contributors][contributors-shield]][contributors-url] | ||
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![MIT License][license-shield]][license-url] | ||
| [![LinkedIn][linkedin-shield]][linkedin-url] | ||
|  | ||
|
|
||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <p align="center"> | ||
| <a href="https://github.com/a01334390/eightQueens"> | ||
| <img src="https://github.com/othneildrew/Best-README-Template/blob/master/images/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Eight Queens</h3> | ||
|
|
||
| <p align="center"> | ||
| Simple application to solve the eight queens problem using Flutter and Dart | ||
| <br /> | ||
| <a href="https://github.com/a01334390/eightQueens"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/a01334390/eightQueens">View Demo</a> | ||
| · | ||
| <a href="https://github.com/a01334390/eightQueens/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/a01334390/eightQueens/issues">Request Feature</a> | ||
| </p> | ||
| </p> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| ## Table of Contents | ||
|
|
||
| * [About the Project](#about-the-project) | ||
| * [Built With](#built-with) | ||
| * [Getting Started](#getting-started) | ||
| * [Prerequisites](#prerequisites) | ||
| * [Installation](#installation) | ||
| * [Usage](#usage) | ||
| * [Contributing](#contributing) | ||
| * [License](#license) | ||
| * [Contact](#contact) | ||
|
|
||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| This is a simple application that attempts to show all possible solutions to a given n-queens problem. | ||
|
|
||
| ### Built With | ||
|
|
||
| * [Flutter](https://flutter.dev) | ||
| * [Dart](https://dart.dev) | ||
| * [Android Studio](https://developer.android.com/studio) | ||
| * [Github Actions](https://github.com/features/actions) | ||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This project is a starting point for a Flutter application. | ||
| To get a local copy up and running follow these simple steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| This is an example of how to list things you need to use the software and how to install them. | ||
| **To run, you'll need to install the following libraries and applications** | ||
|
|
||
| * [Flutter](https://flutter.dev) | ||
| * [Dart](https://dart.dev) | ||
| * [Android Studio](https://developer.android.com/studio) | ||
|
|
||
| Instructions will depend on your Operating System and Development Environment. | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/a01334390/eightQueens.git | ||
| ``` | ||
| 2. Install all application dependencies | ||
| ```sh | ||
| flutter pub get | ||
| ``` | ||
|
|
||
| <!-- USAGE EXAMPLES --> | ||
| ## Usage | ||
|
|
||
| This is a very simple application, interaction is mainly based on a Main Application view consisting of a Text Field and a Button and a List View. | ||
|
|
||
| Usage should be pretty straightforward. | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
|
|
||
|
|
||
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Fernando Martin - [@martntn](https://www.linkedin.com/in/martntn/) - martin.delangel26@gmail.com | ||
|
|
||
| A few resources to get you started if this is your first Flutter project: | ||
| Project Link: [https://github.com/a01334390/eightQueens](https://github.com/a01334390/eightQueens) | ||
|
|
||
| - [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) | ||
| - [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) | ||
|
|
||
| For help getting started with Flutter, view our | ||
| [online documentation](https://flutter.dev/docs), which offers tutorials, | ||
| samples, guidance on mobile development, and a full API reference. | ||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/a01334390/eightQueens | ||
| [contributors-url]: https://github.com/a01334390/eightQueens/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/a01334390/eightQueens | ||
| [forks-url]: https://github.com/a01334390/eightQueens/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/a01334390/eightQueens | ||
| [stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/a01334390/eightQueens | ||
| [issues-url]: https://github.com/othneildrew/Best-README-Template/issues | ||
| [license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square | ||
| [license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://www.linkedin.com/in/martntn/ | ||
| [product-screenshot]: images/screenshot.png |