Skip to content

xbz-24/WX-Editor

Repository files navigation

WX-Editor

lightweight code editor built using the wxWidgets framework, has nix shell for cross platform easy compilation.

Overview

wxEditor is a lightweight, cross-platform text editor I am designing for it to replace my main C++ editor. It is built using the wxWidgets framework to provide a native look and feel on each platform (Windows, OSX and Artix/NixOS, the platforms I use).

- First Milestone - Scintilla Widget Integration

image

- Intermediate Milestone - Designing the UI using wxFormBuilder

image

- Second Milestone - Implementing the UI from the wxFormBuilder XML file

image

- Third Milestone - Redimention of some sizers from layout and adding custom Logo

image

- Intermediate Milestone - Introduction of the UML class diagram representation

image

- Description of the project

Features

  • Text editing
  • C++ Syntax highlighting
  • Dark and Light mode
  • Find and Replace
  • Undo and Redo
  • File operations: Open, Save, and Create New files

Getting Started

Prerequisites

  • C++ Compiler (GCC, Clang, MSVC)
  • wxWidgets library
  • Windows: vcpkg
  • OSX: Homebrew, and Xcode-Command-Line-Tools

Building the Application

  1. Clone the repository:

    git clone https://github.com/Xbz-24/WX-Editor.git
    
  2. Build the project: preferred way will always be using nix.

    • NixOS:
    nix-shell
    mkdir build && cd build
    cmake -S .. -B .
    
    • Artix:
      sudo pacman -S wxgtk3 wxgtk-common wxgtk3-contrib wxgtk3-docs wxgtk3-i18n wxgtk3-media wxgtk3-unicode wxgtk3-stc wxgtk3-tools wxgtk3-webview wxgtk3-xrc
      mkdir build && cd build
      cmake -S .. -B .
    
    • Windows: use vcpkg to install wxWidgets and other dependencies
    vcpkg integrate install
    mkdir build && cd build
    cmake -S .. -B .
    
    • OSX:
      brew install wxwidgets
      mkdir build && cd build
      cmake -S .. -B .
    
  3. Run the application:

    ./editor
    

Usage

Launch the application and use the menu or toolbar to perform actions like opening a file, saving changes, or toggling the editor theme.

Contributing

Contributions to wxEditor are always welcome. Please feel free to submit pull requests or open issues to discuss proposed changes.

License

This project is licensed under the MIT License - see the license file for details.

Acknowledgments

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published