v 1.3.0

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Dário Guimarães
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,138 @@
-# Fridrich Trainer
+<h1 align="center">
+	<a href="https://www.github.com/Darguima/FridrichTrainer">
+		<img alt="Fridrich Trainer" src="./readme/FridrichTrainerLogoHorizontal_500.png" width="350px">
+	</a>
+</h1>
 
-* A ReactNative application that will help you train the Fridrich method of the Rubik's Cube.
+---
+
+<h2 align="center">
+	Fridrich Trainer
+</h2>
+
+<p align="center">
+	Fridrich Trainer is an app to practice the most famous method to solve the Rubik's Cube. To improve since the F2L to the OLL and the PLL. All in one simple and intuitive application. Fridrich Trainer is also an open-source project so is possible anyone help since reporting bugs, writing code, documentation, giving ideas or just checking the <a href="https://www.github.com/Darguima/FridrichTrainer">homepage</a>.
+</p>
+
+<br/>
+
+<p align="center">
+	<img src="./readme/LandingPage.png" width="150px"/>
+	<img src="./readme/F2L_TrainPage.png" width="150px"/>
+	<img src="./readme/OLL_ConfigPage.png" width="150px"/>
+	<img src="./readme/PLL_ListCases.png" width="150px"/>
+</p>
+
+---
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Pages/Features](#pages/features)
+- [Technologies Used](#technologies-used)
+- [License](#license)
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+- `Git` to clone the repository;
+
+- `Yarn` to install dependencies;
+
+- For run the project you will need the `Expo` Environment configured. You can follow the [Expo Official Documentation](https://docs.expo.io/get-started/installation/);
+
+- This project was only tested and developed for Android. So I don't know if it works properly in IOS. Is recommended that you run it in an `Android Phone`;
+
+### Cloning
+
+- To start you can clone this repository to your local machine using:
+
+> `git clone https://github.com/Darguima/FridrichTrainer.git`
+
+### Installing Dependencies
+
+- Now you can install all the dependencies with yarn:
+
+> `yarn`
+
+### Setup
+
+- To setup the application you can use:
+
+> `yarn start`
+
+### Running the App
+
+- Finally to run the App you only need to scan the QRCode (you need have the `Expo Go` App on your phone)
+
+---
+
+## Pages/Features
+
+### Landing Page
+
+<img src="./readme/LandingPage.png" width="30%" style='max-width:300px'/>
+
+* Of course we start with the Landing Page
+* With a simplistic menu to select one of the three steps of the CFOP.
+
+___
+
+### Train Page
+
+<div>
+	<img src="./readme/F2L_TrainPage_without_options.png" width="22%" style='max-width:300px'/>
+	<img src="./readme/F2L_TrainPage.png" width="22%" style='max-width:300px'/>
+	<img src="./readme/OLL_TrainPage.png" width="22%" style='max-width:300px'/>
+	<img src="./readme/PLL_TrainPage.png" width="22%" style='max-width:300px'/>
+</div>
+
+* Is there where you will pass the most of the time
+* All of the 3 choices have the same layout and workflow, being the only difference the design of the cube simulations
+* In the header we 2 buttons to the `Config Page` and to the `List Cases`
+* There are also 2 buttons, one to show the cube simulation and other to show the solve
+
+___
+
+### Config Page
+
+<img src="./readme/OLL_ConfigPage.png" width="30%" style='max-width:300px'/>
+
+* There you can choose what cases do you want that appear on the Train Page.
+
+___
+
+### List Cases
+
+<img src="./readme/PLL_ListCases.png" width="30%" style='max-width:300px'/>
+
+* To can have a little idea of the cases that we already done and whats we will do
+* We also can to reorganize the order of the cases
+
+---
+
+## Technologies Used
+
+- core
+	- JavaScript/TypeScript
+	- React Native
+	- Expo
+
+- navigation
+	- [React Navigation](https://github.com/react-navigation/react-navigation) - used to navigate between the screens
+
+- storage
+	- [Async Storage](https://github.com/react-native-async-storage/async-storage) - to save what cases are selected on the `Config Page`
+
+- others
+	- [react-native-draggable-flatlist](https://github.com/computerjazz/react-native-draggable-flatlist) - used to create the `List Cases` page
+	- [Cube Simulator](https://github.com/Darguima/CubeSimulator) - used indirectly to create the SVGs to the cube simulations
+	- [react-native-svg](https://github.com/react-native-svg/react-native-svg) - used to load the SVGs of the cube simulation
+
+---
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "fridrich_trainer",
-  "version": "1.2.1",
-  "description": "A ReactNative application that will help you train the Fridrich method of the Rubik's Cube.",
+  "version": "1.3.0",
+  "description": "Fridrich Trainer is an app to practice the most famous method to solve the Rubik's Cube. To improve since the F2L to the OLL and the PLL. All in one simple and intuitive application. Fridrich Trainer is also an open-source project so is possible anyone help since reporting bugs, writing code, documentation, giving ideas or just checking the homepage.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Darguima/FridrichTrainer.git"