Skip to content
This repository was archived by the owner on Oct 10, 2024. It is now read-only.
/ toad_writer Public archive

A simple text editor that provides a typesetting system that is easy to use.

License

Notifications You must be signed in to change notification settings

Feohr/toad_writer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ToadWriter

Toad Writer Icon Name Toad Writer Icon Logo

Notice: This project has been discontinued. It is incomplete in it's current state. You are allowed to create a fork and work on it as a separate project with acknowledgement and reference to this repository as the progenitor.

Description

A text editor that provides a typesetting system and a feature which infers the written text and notifies in case of contradictions. This is especially useful for fiction authors who want to avoid plotholes in their writings. ToadWriter draws inspiration from various typesetting systems like LaTeX, Markdown and XML.

Table of Contents

Prototype

Prototype Sample

Installation

Manual

To install Toad Writer manually you need to compile the repository in your local machine and execute the target to run it. First make sure you have GTK v4.8 installed in your system as well as Rust.

Rust installation

Follow the steps to install rust here.

GTK Installation

GTK On Linux

To check if your linux system already has GTK installed, run the following command on linux:

$ pkg-config --modversion gtk4

Or:

$ gtk-launch --version

If you do not have GTK installed then please install GTK:

  • On Arch/Manjaro and derivatives:

    $ sudo pacman -S gtk4 base-devel
  • On Debian/Ubuntu and derivatives:

    $ sudo apt install libgtk-4-dev build-essential
  • On Fedora and derivatives:

    $ sudo dnf install gtk4-devel gcc
GTK On macOS

Run the following command in your terminal:

$ brew install gtk4
GTK On Windows

When preparing your Windows machine, you have to decide between either using the MSVC toolchain or the GNU toolchain. If in doubt, go for MSVC since that is the default on Windows. You will want to go for the GNU toolchain if you depend on libraries that can only be compiled with the GNU toolchain.

  • Install:

    • Build GTK 4 with gvsbuild and MSVC (recommended)

    • Build GTK 4 manually with MSVC

    • Install GTK 4 with MSYS2 and the GNU toolchain

Compilation

  • To compile, open the terminal/command prompt in the root directory of the project and run the command:

    $ cargo build --release
  • The binary will be present under /target/release/. Run as is or add it to your path.

License

The following project is licensed under BSD 3-clause "New" or "Revised" License.

Style Guide

To learn more about the styling guidelines: Style Guide.

Contribution

Unless you explicitly state otherwise, any contribution submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.

About

A simple text editor that provides a typesetting system that is easy to use.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published