-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from animeiml/develop
#Main/Develop - Create project's readme
- Loading branch information
Showing
3 changed files
with
111 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 DrawAI | ||
|
||
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. |
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 |
---|---|---|
@@ -0,0 +1,90 @@ | ||
<p align="center"> | ||
<em> | ||
<img src="https://github.com/animeiml/drawAI/blob/develop/.github/assets/readme-cover.png" alt="Logo" width=860><br><br> | ||
</em> | ||
</p> | ||
|
||
<h1 align="center"> | ||
DrawAI | ||
</h1> | ||
|
||
<div> | ||
<p align="center"> | ||
<a href="#"> | ||
<img src="https://img.shields.io/static/v1?label=Language&message=Swift&color=F05138&style=for-the-badge&logo=Swift" alt="Language: Swift"> | ||
</a> | ||
<a href="#"> | ||
<img src="https://img.shields.io/static/v1?label=Editor&message=Xcode&color=147EFB&style=for-the-badge&logo=Xcode" alt="Editor: Xcode"> | ||
</a> | ||
<br/> | ||
<a href="#"> | ||
<img src="https://img.shields.io/static/v1?label=Available%20on&message=iOS/iPadOS&color=000000&style=for-the-badge&logo=Apple" alt="Available on: iOS/iPadOS"> | ||
</a> | ||
</p> | ||
</div> | ||
|
||
## Table of Contents | ||
|
||
<p align="center"> | ||
<a href="#about">About</a> • | ||
<a href="#revised-concepts">Revised Concepts</a> • | ||
<a href="#installation">Installation</a> • | ||
<a href="#technologies">Technologies</a> • | ||
<a href="#license">License</a> | ||
</p> | ||
|
||
## 📌About | ||
|
||
<div> | ||
<p align="center"> | ||
<em> | ||
An app for iPad and iOS with the aim of challenging people to draw anime characters or objects as similar as possible to the original design!<br/>DrawAI was built with UIKit and uses the Vision framework to analyze similarity between images. </em> | ||
</p> | ||
</div> | ||
|
||
## 👓Revised Concepts | ||
|
||
- Use of Vision for comparing images similarity | ||
- Interface built by using XIB | ||
- MVVM Pattern | ||
|
||
## 📕Installation | ||
|
||
**You must have already installed** | ||
- [Xcode 12.5+](https://developer.apple.com/xcode/) | ||
|
||
**Recommendations** | ||
- It is recommended that you have at least the macOS BigSur | ||
|
||
**Let's divide it into 2 steps.** | ||
1. Clone this repository | ||
2. Open the Xcode project | ||
--- | ||
### 1. Clone this repository | ||
``` | ||
git clone https://github.com/animeiml/drawAI | ||
``` | ||
--- | ||
### 2. Open the Xcode project | ||
``` | ||
open .xcodeproj | ||
``` | ||
|
||
## 🌐Technologies | ||
|
||
- [Swift](https://www.apple.com/br/swift/) | ||
- [Vision](https://developer.apple.com/documentation/vision) | ||
- [UIKit](https://developer.apple.com/documentation/uikit/) | ||
- [PencilKit](https://developer.apple.com/documentation/pencilkit) | ||
|
||
## 📝License | ||
|
||
Released in 2021. | ||
|
||
This project is under the <b>MIT license</b>. | ||
|
||
Made with love by: | ||
- [Nicole Guedes](https://www.behance.net/niccoguedes) 🧑🏻🎨 (Designer) | ||
- [Alessandro Negrão](https://github.com/AlessandroNegrao) 🤖 (Developer) | ||
- [João Guilherme](https://github.com/guicfreitas) 👾 (Developer) | ||
- [Leonardo Viana](https://github.com/leoskrr) 👻 (Developer) |