Write all the README.md with LICENSE.md and add some images

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 antoine.perederii
+
+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,6 +1,6 @@
 <img src="./Documentation/images/banqualeLogo.jpg" height="130">
 
-# Banquale
+# Banquale - Android Bank App
 
 [![Build Status](https://codefirst.iut.uca.fr/api/badges/antoine.perederii/Banquale/status.svg)](https://codefirst.iut.uca.fr/antoine.perederii/Banquale)
 [![Quality Gate Status](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=Banquale&metric=alert_status&token=1a49717e4d2f15e2eecaaa971ebd8c83fb9bd5c5)](https://codefirst.iut.uca.fr/sonar/dashboard?id=Banquale)
@@ -9,44 +9,77 @@
 [![Vulnerabilities](https://codefirst.iut.uca.fr/sonar/api/project_badges/measure?project=Banquale&metric=vulnerabilities&token=1a49717e4d2f15e2eecaaa971ebd8c83fb9bd5c5)](https://codefirst.iut.uca.fr/sonar/dashboard?id=Banquale)
 
 # Table of Content
-[overview--big-picture](#overview--big-picture) | [Features](#features) | [Getting Started](#getting-started) | [Prerequisites](#prerequisites)
-
+[Overview](#overview--big-picture) | [Documentation](#documentation) | [Prerequisites](#prerequisites) | [Getting Started](#getting-started) | [Features](#features) | [What we have now ?](#what_we_have_now) | [Screen Capture](#screen_capture) |[Usage](#usage)| [Built With](#built_with) | [Known issues and limitations](known_issues_and_limitations) | [Contributors](#contributors) | [How to contribute ?](#how_to_contribute) | [License](#license) | [Acknowledgments](#acknowledgments)
 
 ## Overview / Big picture
-This project is a ....
-
-## Features
+Banquale is a mobile banking application built using .NET MAUI technology for the Android platform. This application provides users with a simple and intuitive way to manage their finances, including viewing account balances, transferring money and more.
 
 ## Documentation 
-Doxygen 
-Wiki
-
-## Getting Started
+Documentation and information about 'Banquale' are available
+<a src="https://codefirst.iut.uca.fr/documentation/antoine.perederii/Banquale/doxygen/index.html">here</a>
 
 ### Prerequisites
+* [Visual Studio 2022](https://visualstudio.microsoft.com/fr/vs/) - IDE
+* [Git](https://git-scm.com/) - Versioning
+* [.NET 7.0 SDK](https://docs.microsoft.com/fr-fr/dotnet/maui/get-started/installation) - Framework
+* [Android SDK](https://developer.android.com/studio) - Emulator
 
-### Installation
-
-## Running the tests
-
-## How to contribute ?
+## Getting Started
+1. Clone the repository
+2. Open the **'Banquale.sln'** project in Visual Studio 2022
+3. Set the startup project to Banquale.Android
+4. Select the emulator you want to use or connect your phone
+5. Build and run the project
 
-## What we have now ?
+## Features
+* View account balances and transaction history
+* Transfer money between accounts
+* View and manage account
+
+## What we have now
+The application is functional but the color is not good and the design is not finished. All the C# code is not commented and the documentation is not finished.
+
+## Screen Capture
+<img src="./Documentation/images/splash.jpg" height="300">
+<img src="./Documentation/images/connection.jpg" height="300">
+<img src="./Documentation/images/balance.jpg" height="300">
+<img src="./Documentation/images/menu.jpg" height="300">
+<img src="./Documentation/images/help.jpg" height="300">
+<img src="./Documentation/images/accounts.jpg" height="300">
+<img src="./Documentation/images/rib.jpg" height="300">
+<img src="./Documentation/images/payement.jpg" height="300">
 
 ## Usage
-
-## Known issues and limitations
-deux blanc en fin de lignes = saut de ligne  
-sdf
-## Authors 
-
-## Acknowledgments
+* The application is used to manage your bank account
+* You can see your balance, your transaction history, your RIB, your accounts and you can make a transfer to another account
+* You can also change account
+
+## Built With
+* [Visual Studio 2022](https://visualstudio.microsoft.com/fr/vs/) - IDE
+* [CodeFirst](https://codefirst.iut.uca.fr/) - GitLab
+  * [Drone](https://codefirst.iut.uca.fr/) - CI
+  * [SonarQube](https://codefirst.iut.uca.fr/sonar/) - Quality
+* [.NET MAUI 7.0](https://docs.microsoft.com/fr-fr/dotnet/maui/get-started/installation) - Framework
+  * [C#](https://docs.microsoft.com/fr-fr/dotnet/csharp/) - Language
+  * [XAML](https://docs.microsoft.com/fr-fr/dotnet/desktop-wpf/fundamentals/xaml) - Language
+  * [Xamarin.Essentials](https://docs.microsoft.com/fr-fr/xamarin/essentials/) - Library  
+* [Doxygen](https://codefirst.iut.uca.fr/sonar/) - Documentation
+
+<!-- ## Known issues and limitations -->
+
+## Contributors
+* [Antoine PEREDERII](https://codefirst.iut.uca.fr/u/antoine.perederii)
+* [Titouan LOUVET](https://codefirst.iut.uca.fr/u/titouan.louvet)
+
+## How to contribute
+1. Clone it (<https://codefirst.iut.uca.fr/antoine.perederii/Banquale/fork>)
+2. Create your feature branch (`git checkout -b feature/featureName`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/featureName`)
+5. Create a new Pull Request
 
 ## License 
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
 
-
-```python
-print("Bonjour, monde!")
-```
-
-SAÉ 2.01 Développement d'une application Le projet est une app mobile de Gestion Bancaire. PEREDERII Antoine, LOUVET Titouan
+## Acknowledgments
+This project was inspired by our mobile bank app, the need for a modern and user-friendly mobile banking application. Special thanks to the .NET MAUI community for their contributions and support.