Skip to content

Commit

Permalink
Update description and build information
Browse files Browse the repository at this point in the history
Description adds XRC to the possible outputs. Build information adds C++20
requirement and Windows-only build.
  • Loading branch information
KeyWorksRW committed Jul 11, 2022
1 parent 3c1aae1 commit b4a52fe
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ![logo](src/art_src/logo64.png) wxUiEditor

This Windows GUI tool is used to create and maintain [wxWidgets](https://docs.wxwidgets.org/trunk/index.html) UI elements (dialogs, menus, etc.), generating C++ output code. Minimal requirement for compiling output files is a C++11 compliant compiler and **wxWidgets** 3.0 (version 3.1 needed for full functionality).
This WYSIWYG tool is used to create and maintain [wxWidgets](https://docs.wxwidgets.org/trunk/index.html) UI elements (dialogs, menus, etc.), generating either C++ or XRC code. Minimal requirement for compiling C++ output files is a C++11 compliant compiler and **wxWidgets** 3.0 (version 3.2 needed for full functionality).

In addition to creating new projects, the following project types can be imported:

Expand All @@ -11,13 +11,15 @@ In addition to creating new projects, the following project types can be importe
- **XRC** (including exports from **DialogBlocks**)
- **Windows Resource Dialogs** (Click [here](docs/import_winres.md) for more information)

**wxUiEditor** is a 64-bit app that runs natively on Windows 10 or later, and with **Wine** on Unix systems.

## Status

[![CodeQL](https://github.com/KeyWorksRW/wxUiEditor/workflows/CodeQL/badge.svg)](https://github.com/KeyWorksRW/wxUiEditor/actions?query=workflow:"CodeQL") [![GitHub tag](https://img.shields.io/github/tag/KeyWorksRW/wxUiEditor?include_prereleases=&sort=semver&color=blue)](https://github.com/KeyWorksRW/wxUiEditor/releases/)

## Building

To build the Windows version of **wxUiEditor**, run the following two commands from the root of the repository:
You will need a C++20 compliant compiler to build **wxUiEditor**. Currently only Windows builds are supported. To build, run the following two commands from the root of the repository:

```
cmake -G "Ninja Multi-Config" . -B build
Expand Down

0 comments on commit b4a52fe

Please # to comment.