Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexjmercer/ember-text_editor
Learning the Qt Framework for C++ by building a Text Editor Application from scratch. Built in Visual Studio 2022 using Qt 6.
https://github.com/alexjmercer/ember-text_editor
cpp14 gui-application qt6 qtwidgets text-editor windows-app
Last synced: 3 months ago
JSON representation
Learning the Qt Framework for C++ by building a Text Editor Application from scratch. Built in Visual Studio 2022 using Qt 6.
- Host: GitHub
- URL: https://github.com/alexjmercer/ember-text_editor
- Owner: AlexJMercer
- License: gpl-3.0
- Created: 2024-06-07T20:19:09.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T17:57:03.000Z (3 months ago)
- Last Synced: 2024-10-24T02:16:38.046Z (3 months ago)
- Topics: cpp14, gui-application, qt6, qtwidgets, text-editor, windows-app
- Language: C++
- Homepage:
- Size: 151 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
🔥 Ember - Text Editor
## Introduction
**Ember** is a lightweight and fast text editor designed to provide a seamless document editing experience, with a special focus on quick file handling and minimal system resource usage. Ember is ideal for individual users and developers who want to view and edit text or code files quickly, without unnecessary overhead. With support for syntax highlighting, customization options, and a clean UI, Ember aims to improve productivity while remaining highly responsive, even when handling larger documents.
---
## Current Features
- **Quick File Loading**: Open and edit text files almost instantly, regardless of size.
- **Multiple File Format Support**: Works with plain text (`.txt`), and several popular programming languages such as C++, Python, and JavaScript.
- **Undo/Redo Support**: Easily revert or reapply changes to your document with unlimited undo/redo.
---
## Upcoming Features
- **Syntax Highlighting**: Basic syntax highlighting for common programming languages to make code more readable.
- **Customizable UI**: Change the theme, font, and layout of the editor to suit your personal preferences.
- **Auto-save Feature**: Prevent data loss by automatically saving your progress during editing sessions.
- **Enhanced Auto-Save**: More control over auto-save intervals and options for manual save snapshots.
- **Advanced Syntax Highlighting**: Support for more languages and improved accuracy in highlighting.
- **Performance Optimization**: Further improvements to handle larger files and complex codebases more efficiently.
---
## How to Install
To install and use **Ember** locally, follow these steps:
### Prerequisites:
- **C++ Compiler**: Ensure you have a C++ compiler installed (like `g++` or MSVC for Windows).
- **Qt 6 Framework**: Ember is built using the Qt 6 framework. Install Qt by following the instructions for your platform from the [Qt website](https://www.qt.io/download).
### Clone the Repository:
1. Clone the repository to your local machine:
```bash
https://github.com/AlexJMercer/Ember-Text_Editor.git
cd Ember-Text_Editor
```
### Build Instructions:
2. Open the project in Visual Studio from the `.sln` file.
- Ensure that Qt is properly integrated into Visual Studio (you can set the Qt version in your project's properties).
- Build the project by selecting Build > Build Solution.
3. Once the build process is complete, you can run Ember directly from Visual Studio by selecting Debug > Start Without Debugging or navigating to the build folder and running the executable.
---
## License
This project is licensed under the **GPL-3.0 License**. You are free to use, and distribute the code, however, changing/modifying it is not allowed.
For more details, see the [LICENSE](./LICENSE.txt) file.