Skip to content

AnishBramha/pril

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The PRiL Text Editor

PRiL is a free and open source text editor developed using the wxWidgets GUI library in C++. It supports all major text formats and runs on all major platforms (Linux, macOS and Windows).

Contribution

Pull requests are welcome! Please contribute to improve this project and provide suggestions by raising issues.

Table of Contents

Installation

To install the executable wrappers directly, check out the latest release. Download and extract to get the executable.

Tip

You might need to disable gatekeeping mechanisms temporarily as this release lacks a signed certificate.

Build from source

Get the source code from the release page.

Install dependencies


1. Package Manager

  • Get chocolatey for Windows.

  • Get homebrew for macOS by running the following command on bash/zsh:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Important

Add to path by running the following two commands:

(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zprofile

eval "$(/opt/homebrew/bin/brew shellenv)"
  • This build guide covers apt, dnf and pacman, which are usually the default package managers on Debian-based, RedHat-based and Arch-based Linux distros.

2. C/C++ compiler and tools

  • On Windows, install minGW64 by running the following command in PowerShell with administrator privileges:
choco install mingw

Important

Verify if minGW is added to path by running $env:Path in PowerShell and check if the path to the bin folder is visible. If not, edit the System Environment Variables and add it to path manually.

  • On macOS, install the Xcode command line tools by running:
sudo xcode-select --install
  • On Linux, run the following commands, based on your package manager:
sudo apt-get install build-essential

sudo dnf group install "C Development Tools and Libraries" "Development Tools"

sudo pacman -S base-devel

Tip

To verify installation, run:

g++ --version

3. Make

This project uses GNU make to run makefiles for easier compilation, linking and execution.

Note

If you do not want to use make, skip to GUI library

  • On Windows, run in PowerShell admin:
choco install make

Tip

To verify installation, run:

make --version
  • On macOS, make is installed with the Xcode command line tools.

  • On Linux, make comes packaged with build-essential/base-devel.

4. wxWidgets

wxWidgets is a cross-platform free and open source GUI library with support for building native-looking OS-agnostic applications.

  • On Windows, run in PowerShell admin:
choco install wxwidgets
  • On macOS, run in bash/zsh:
brew install wxwidgets

Tip

To verify installation, run:

wxwidgets --version

Note

If you skipped installing make, jump directly to raw run.

Build and run project


1. Clean run

Note

Recommended for a cleaner compilation and execution.

  • To generate the executable (only) and start the application automatically, run the following command in the project directory:
make run

2. Generate compilation and linking intermediates

  • To generate the intermediate object files along with the executable, run the following command in the project directory:
make all
  • On Windows, run:
./pril-editor.exe
  • On macOS and Linux, run:
./pril-editor

To clean up the project directory and remove the object files, run:

make clean

3. Run without using make

To generate the object files, run the following command in the project directory:

g++ -std=c++17 -c `wx-config --cxxflags` App.cpp Frame.cpp
  • To generate the executable on Windows, run:
g++ -o pril-editor.exe `wx-config --libs` App.o Frame.o
  • On macOS and Linux, run:
g++ -o pril-editor `wx-config --libs` App.o Frame.o

Alternatively, to generate the executable directly, run:

  • On Windows:
g++ -std=c++17 -o pril-editor.exe `wx-config --cxxflags --libs` App.cpp Frame.cpp
  • On macOS and Linux:
g++ -std=c++17 -o pril-editor.exe `wx-config --cxxflags --libs` App.cpp Frame.cpp

Run the executable as given in previous section.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published