Skip to content

Commit

Permalink
Add main docs README, docs badge (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
EgzonArifi authored Aug 17, 2023
1 parent 94fe8fe commit c937c4e
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
<p align="center">
<img src="Resources/Images/Lingua.png" width="400" max-width="90%" alt="Lingua" />
    <a href="Resources/Docs/README.md">
<img src="Resources/Images/Lingua.png" width="90%" alt="Lingua" />
    </a>
</p>
<p align="center">
<a href="Resources/Docs/README.md">
<img src="http://img.shields.io/badge/read_the-docs-2196f3.svg" alt="Documentation">
</a>
<a href="https://www.swift.org" alt="Swift">
<img src="https://img.shields.io/badge/Swift-5.7-orange.svg" />
</a>
Expand Down Expand Up @@ -49,11 +54,8 @@ We have prepared a tamplate for sheet structure for you. What you have to do is

[Mobile Localizations Template - Google Sheets](https://docs.google.com/spreadsheets/d/1Cnqy4gZqh9pGcTF_0jb8QGOnysejZ8dVfSj8dgX4kzM)



**Sheet structure**: For detailed information about the sheet structure used in the Lingua localization tool, please refer to the [Sheet Structure Documentation](Resources/Docs/App/SHEET_STRUCTURE.md).


**Important:** Make sure to replace the existing API key in your application with the newly generated one. Also, ensure that the Google Sheet you're trying to access has its sharing settings configured to allow access to anyone with the link. You can do this by clicking on "Share" in the upper right corner of the Google Sheet and selecting "Anyone with the link."

### b. Obtain the sheet id
Expand Down
27 changes: 27 additions & 0 deletions Resources/Docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Lingua Documentation

Welcome to the main documentation repository for **Lingua**. This directory provides a comprehensive guide to our tool, covering both its usage and underlying architecture. Here's a breakdown of the two main sections:

## 1. [App - Usage & Best Practices](./App/)

This section focuses on helping users effectively utilize "Your Tool Name". Here, you'll find:

- **Usage Instructions**: Step-by-step guides on how to get started and utilize the main features of our tool.
- **Best Practices**: Tips and recommendations for maximizing the utility and efficiency of **Lingua**.
- ... and more!

[📁 Click here to explore the App documentation](./App/)

## 2. [Lingua Architecture](./Architecture/)

Dive deeper into the design and structure of **Lingua** with our architecture documentation. This section provides insights into:

- **System Design**: Understand the overall system layout and how different components interact.
- **Technical Specs**: Details about the technologies used, data flow diagrams, and more.
- ... and other technical insights!

[📁 Click here to explore the Lingua Architecture documentation](./Architecture/)

---

We encourage users to familiarize themselves with both sections to fully understand and utilize **Lingua** to its maximum potential. If you have further questions or feedback, please don't hesitate to reach out.
Binary file modified Resources/Images/Lingua.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c937c4e

Please sign in to comment.