-
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.
- Loading branch information
1 parent
1f092f8
commit e5724ec
Showing
1 changed file
with
113 additions
and
1 deletion.
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 +1,113 @@ | ||
| # Notation | ||
| <h1 align="center"> | ||
| Notation | ||
| </h1> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/numanzamandipuu/Notation/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> | ||
| · | ||
| <a href="https://github.com/numanzamandipuu/Notation/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a> | ||
| . | ||
| <a href="https://github.com/numanzamandipuu/Notation/discussions">Ask a Question</a> | ||
| </div> | ||
|
|
||
|
|
||
| <div align="center"> | ||
| <br> | ||
|
|
||
| [](LICENSE) | ||
| [](https://github.com/numanzamandipuu/Notation/pulls) | ||
| [](https://github.com/numanzamandipuu/Notation/issues) | ||
| [](https://github.com/numanzamandipuu/) | ||
|
|
||
| </div> | ||
|
|
||
|  | ||
|
|
||
| <br> | ||
|
|
||
| ### Notation is a Chromium-Based Browser extension that uses a special algorithm to highlight the first syllable of a word, allowing readers to focus on the highlighted parts and read up to 1.75x faster. With customizable font weight and opacity, Notation enhances the reading experience on any website. | ||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
|
|
||
| <details open="open"> | ||
|
|
||
| <summary> | ||
| <h1>Table of Contents</h1> | ||
| </summary> | ||
|
|
||
| - [Installation](#installation) | ||
| - [Features](#features) | ||
| - [System Architecture](#system-architecture) | ||
| - [Usage](#usage) | ||
| - [Contributing](#contributing) | ||
| - [Installation](#installation) | ||
| - [HTTPS](#https) | ||
| - [SSH](#ssh) | ||
| - [GitHub CLI](#github-cli) | ||
| - [GitHub Desktop](#github-desktop) | ||
| - [Support](#support) | ||
| - [License](#license) | ||
| - [Acknowledgements](#acknowledgements) | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
| # Installation | ||
|
|
||
|
|
||
|
|
||
| # Features | ||
|
|
||
| To make this Extension more user-friendly and accessible, the following features have been included: | ||
|
|
||
| - [**Easy Installation:**](#installation) Installation is a breeze with Notation. Our [well-documented guide](#installation) ensures you'll be up and running in no time. | ||
|
|
||
| - [**Stunning UI:**](https://github.com/numanzamandipuu/Notation/tree/main/src/popup) Notation features a visually impressive User Interface that is easy to navigate and a pleasure to use. | ||
|
|
||
| - [**Comprehensive Documentation:**](https://github.com/numanzamandipuu/Notation#readme) Our Extension has a detailed README file, providing all the necessary information and instructions. Our documentation is an informative guide to help you get the most out of Notation. | ||
|
|
||
| - [**Stellar Support:**](https://github.com/numanzamandipuu/Notation/issues) We are committed to providing exceptional support to our users. If you encounter any problems, drop an [Issue here](https://github.com/numanzamandipuu/Notation/issues), and we will work quickly to resolve them to ensure your experience with Notation is as smooth as possible. | ||
|
|
||
| - [**Contributions Welcome:**](https://github.com/numanzamandipuu/Notation/pulls) The repository is open to contributions from the community. Users can contribute their own solutions or even suggest improvements to existing ones. | ||
|
|
||
| - [**License:**](LICENSE) This repository follows the Apache-2.0 license. Users can use and modify the code for personal and commercial purposes if they give appropriate credit and maintain the license terms. | ||
|
|
||
| Overall, the purpose of this Extension is to enhance the reading experience of users and, in the meantime, to provide a centralized location for users and developers to access and contribute to the codebase. | ||
|
|
||
|
|
||
|
|
||
| # System Architecture | ||
|
|
||
|
|
||
| # Usage | ||
|
|
||
| To use the repository, navigate to the relevant folder for the problem you're interested in. Then follow the following steps: | ||
|
|
||
| - Each folder contains a C++ solution file and a README file with the original problem link. You can have a look to those files. | ||
| - Review the solution code and problem statement to gain insight into how the problem was solved. | ||
| - Contribute to the repository by submitting solutions to existing problems or adding new solutions following the Contribution Guidelines. | ||
|
|
||
| This repository is intended to provide a resource for competitive programmers of all levels, from beginners to advanced, looking to improve their problem-solving skills and explore new algorithms and data structures. | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|