From b7c22ac3038cfb5884dd7a1c120e8b4f013056f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fernando=20Mart=C3=ADn=20Garc=C3=ADa=20Del=20Angel?= Date: Mon, 17 Feb 2020 19:24:05 -0600 Subject: [PATCH] Update README.md --- README.md | 162 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 153 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a21172a..7691438 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,160 @@ -# eight_queens + -Eight Queens Simple App + + + + + +[![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] +![Test, Build and Release apk](https://github.com/a01334390/eightQueens/workflows/Test,%20Build%20and%20Release%20apk/badge.svg) + + + +
+

+ + Logo + + +

Eight Queens

+ +

+ Simple application to solve the eight queens problem using Flutter and Dart +
+ Explore the docs » +
+
+ View Demo + · + Report Bug + · + Request Feature +

+

+ + + + +## 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 + +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 -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 + +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 + +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 + +Distributed under the MIT License. See `LICENSE` for more information. + + + +## 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. + + +[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