-
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
Showing
8 changed files
with
78 additions
and
143 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,168 +1,81 @@ | ||
| <a name="readme-top"></a> | ||
|
|
||
| <!-- PROJECT SHIELDS --> | ||
|
|
||
| [![Github][github-shield]][github-url] | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://github.com/CharleyDL/neo_aissyr"> | ||
| <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| <a href="https://github.com/CharleyDL/Aissyr"> | ||
| <img src="asset/logo_aissyr_white_M.png" alt="Logo"> | ||
| </a> | ||
|
|
||
| <h3 align="center">NEO AISSYR</h3> | ||
| <br /> | ||
|
|
||
| <p align="center"> | ||
| A WebApp to detect and transcript neo-assyrian glyphs ! | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/CharleyDL/neo_aissyr"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/CharleyDL/neo_aissyr">View Demo</a> | ||
| <br/> | ||
| <br/> | ||
| <a href="https://aissyr-app.streamlit.app"><strong>View Demo</strong></a> | ||
| · | ||
| <a href="https://github.com/CharleyDL/neo_aissyr/issues">Report Bug</a> | ||
| <a href="https://github.com/CharleyDL/Aissyr/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/CharleyDL/neo_aissyr/issues">Request Feature</a> | ||
| <a href="https://github.com/CharleyDL/Aissyr/issues">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#usage">Usage</a></li> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#contact">Contact</a></li> | ||
| <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
|
|
||
| ## About The Project | ||
|
|
||
| [![Product Name Screen Shot][product-screenshot]](https://example.com) | ||
|
|
||
| There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. | ||
|
|
||
| Here's why: | ||
|
|
||
| - Your time should be focused on creating something amazing. A project that solves a problem and helps others | ||
| - You shouldn't be doing the same tasks over and over like creating a README from scratch | ||
| - You should implement DRY principles to the rest of your life :smile: | ||
|
|
||
| Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template! | ||
|
|
||
| Use the `BLANK_README.md` to get started. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### Built With | ||
|
|
||
| This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. | ||
|
|
||
| - [![Python]][Python-url] | ||
| - [![Heroku]][Heroku-url] | ||
| - [![Postgres]][Postgres-url] | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- GETTING STARTED --> | ||
|
|
||
| ## Getting Started | ||
| <br/> | ||
|
|
||
| This is an example of how you may give instructions on setting up your project locally. | ||
| To get a local copy up and running follow these simple example steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| This is an example of how to list things you need to use the software and how to install them. | ||
|
|
||
| - npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
|
|
||
| ### Installation | ||
|
|
||
| _Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ | ||
|
|
||
| 1. Get a free API Key at [https://example.com](https://example.com) | ||
| 2. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/your_username_/Project-Name.git | ||
| ``` | ||
| 3. Install NPM packages | ||
| ```sh | ||
| npm install | ||
| ``` | ||
| 4. Enter your API in `config.js` | ||
| ```js | ||
| const API_KEY = "ENTER YOUR API"; | ||
| ``` | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- USAGE EXAMPLES --> | ||
|
|
||
| ## Usage | ||
|
|
||
| Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. | ||
|
|
||
| _For more examples, please refer to the [Documentation](https://example.com)_ | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- ROADMAP --> | ||
| <!-- TABLE OF CONTENTS --> | ||
| <p align="left"><a href="#readme-top">back to the main branch</a></p> | ||
|
|
||
| ## Roadmap | ||
| <br/> | ||
|
|
||
| - [x] Add Changelog | ||
| - [x] Add back to top links | ||
| - [ ] Add Additional Templates w/ Examples | ||
| - [ ] Add "components" document to easily copy & paste sections of the readme | ||
| - [ ] Multi-language Support | ||
| - [ ] Chinese | ||
| - [ ] Spanish | ||
| <!-- ABOUT THE PROJECT --> | ||
|
|
||
| See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues). | ||
| ## 📚 - About The Project | ||
|
|
||
| <br/> | ||
|
|
||
| <blockquote> | ||
| <p> | ||
| <em> | ||
| This project showcases the expertise necessary to achieve the professional qualification of | ||
| <a href="https://www.francecompetences.fr/recherche/rncp/34757"> | ||
| Artificial Intelligence Developer (RNCP 34757) | ||
| </a> | ||
| , as part of the | ||
| <a href="https://isen-caen.fr/ecole-ia-microsoft-by-simplon-et-isen-ouest/"> | ||
| Microsoft IA Caen School by Simplon x ISEN (Engineer School) | ||
| </a>. | ||
| AIssyr is an original creation by | ||
| <a href="https://www.linkedin.com/in/charleylebarbier/"> | ||
| Charley ∆. Lebarbier | ||
| </a> | ||
| </em> | ||
| </p> | ||
| </blockquote> | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| <br/> | ||
| <br/> | ||
|
|
||
| <!-- ACKNOWLEDGMENTS --> | ||
| <div align="center"> | ||
| <img src="asset/hook.svg" alt="empower assyrian cuneiform research you with new AI toolkit companion"> | ||
| </div> | ||
|
|
||
| ## Acknowledgments | ||
| <br/> | ||
|
|
||
| - [Cuneiform Dataset](https://github.com/CompVis/cuneiform-sign-detection-dataset) | ||
| <p align="center"> | ||
| <em> | ||
| AIssyr Web App is dedicated to researchers to work on the Assyrian | ||
| cuneiforms writing system, providing a toolbox for glyphs classification and labeling images. | ||
| </em> | ||
| </p> | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| <br/> | ||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| ## 🧰 - API Route | ||
|
|
||
| [github-shield]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white | ||
| [github-url]: https://github.com/CharleyDL | ||
| [product-screenshot]: images/screenshot.png | ||
| [Python]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54 | ||
| [Python-url]: https://www.python.org/ | ||
| [Heroku]: https://img.shields.io/badge/Heroku-430098?style=for-the-badge&logo=heroku&logoColor=white | ||
| [Heroku-url]: https://www.heroku.com | ||
| [Postgres]: https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white | ||
| [Postgres-url]: https://www.postgresql.org | ||
| | Route | Description | | ||
| | ------------ | ----------------------------------------------------------- | | ||
| | Account | Verify an account to log in ; Create an account in Database | | ||
| | Archives | Consult the prediction and labelisation archives | | ||
| | Labelisation | Save labelisation in Database | | ||
| | Prediction | Save prediction in Database | | ||
| | Resources | Consult MZL Glyphs information : All or by MZL number | |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.