-
-
Notifications
You must be signed in to change notification settings - Fork 21
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
70d3240
commit 1737b23
Showing
1 changed file
with
148 additions
and
0 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 |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <div align="center"> | ||
|
|
||
| <h1 align="center">Aura Text</h1> | ||
|
|
||
|  | ||
|
|
||
| <p align="center"> | ||
| Eine vollständig mit Python erstellte IDE | ||
| <br /> | ||
| <a href="https://github.com/rohankishore/Aura-Text/wiki"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/rohankishore/Aura-Text/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/rohankishore/Aura-Text/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Inhaltsverzeichnis</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#-about-the-project">Über das Projekt</a> | ||
| </li> | ||
| <li> | ||
| <a href="#-getting-started">Über das Projekt</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Voraussetzungen</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| <ul> | ||
| <li><a href="#with-nuitka">Mit Nuitka</a></li> | ||
| <li><a href="#-as-a-python-file">Als Python-Datei</a></li> | ||
| </ul> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#-contributing">Mitwirken</a></li> | ||
| <li><a href="#-license">License</a></li> | ||
| <li><a href="#-contact">Contact</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| <!-- LANGUAGE SWITCHER --> | ||
| <details> | ||
| <summary>View the README In:</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="https://github.com/rohankishore/Aura-Text/blob/main/.github/README_HN.md">Hindi 🇮🇳</a> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">German</a> | ||
| </li> | ||
| <li><a href="#-roadmap">Español</a></li> | ||
| <li><a href="#-contributing">Russian</a></li> | ||
| <li><a href="#-license">Chinese</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| <br> | ||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## 📖 About The Project | ||
|
|
||
|  | ||
|
|
||
| Aura Text is an excellent text/code editor that offers a wide array of essential tools. Built with PyQt6 and Python, it harnesses the power and flexibility of these technologies. | ||
|
|
||
| With Aura Text, users gain access to a versatile and powerful editing environment. Whether you're working on a small script or a complex project, Aura Text equips you with all the necessary features to streamline your workflow. From syntax highlighting and code completion to smart indentation and advanced terminal, Aura Text ensures that your coding experience is both efficient and enjoyable while being extremely light on your PC. | ||
|
|
||
| <br> | ||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## 🏃 Getting Started | ||
|
|
||
| Let's set up Aura Text on your PC! | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| Run this command in your terminal to install the dependencies at once | ||
| ```sh | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| ### Installation | ||
|
|
||
| #### With Nuitka | ||
|
|
||
| _Below is an example of how you can build Aura Text using Nuitka_ | ||
|
|
||
| - Download / Clone this repository | ||
| - Move the `AuraText` folder in the `LocalAppData` folder to the `AppData/Local` folder. | ||
| - Install Nuitka (`python -m pip install nuitka`) | ||
| - `python -m nuitka --windows-disable-console .\main.py` | ||
|
|
||
| #### 🐍 As a Python File | ||
|
|
||
| - Download / Clone this repository | ||
| - Move the `AuraText` folder in the `LocalAppData` folder to the `AppData/Local` folder. | ||
| - `python -m main.py` | ||
|
|
||
| <br> | ||
|
|
||
| ## Roadmap | ||
|
|
||
| - Make a status bar at the bottom with features similar to PyCharm or other IDEs (Read-only toggle, breadcrumbs, etc) | ||
| - <strike> Custom Theming </strike> | ||
| - <strike> Key Emulation </strike> | ||
| - Split Editing | ||
| - <strike> Python Code Linting </strike> | ||
|
|
||
| <b> and much much more... </b> | ||
|
|
||
|
|
||
| <b> | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## 🛂 Contributing | ||
|
|
||
| Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". | ||
| Don't forget to give the project a star! Thanks again! | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
| <b> | ||
|
|
||
| <!-- LICENSE --> | ||
| ## 🪪 License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE.txt` for more information. | ||
|
|
||
|
|
||
| <!-- CONTACT --> | ||
| ## 📱 Contact | ||
|
|
||
| Your Name - [@Aura_Text](https://twitter.com/Aura_Text) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/rohankishore/Aura-Text](https://github.com/rohankishore/Aura-Text) |