Skip to content

DandyHQ/mace

Repository files navigation

Mace Travis build Status Coverage Status

A modern Unix text editor taking inspiration from Acme, Emacs and Atom.

Screenshot

Screenshot

About

Mace is a programer's text editor that supports the following features:

  • It is fast and light weight while looking good.
  • Executing any text in any window as a command.
  • Customisable hot bar for regularly used commands.
  • Tabbed interface.

Documentation

Mace documentation is in the docs folder.

You should read docs/Introduction.md for a run down of how Mace is intended to work.

docs/Development.md gives is intended to help explain how Mace is structured.

Building

Mace requires the following dependencies:

  • meson
  • xlib
  • fontconfig
  • freetype2
  • cairo

Ubuntu 16.04

# apt install meson libx11-dev libcairo2-dev

Fedora 25

# dnf install meson libX11-devel cairo-devel

OpenBSD 6.1 or snapshots

# pkg_add meson cairo

Compiling

Once you have the dependencies installed, Mace can be compiled as follows:

$ mkdir build
$ meson build
$ ninja -C build

# To run
$ ./build/mace

# or to install

# ninja -C build install
$ mace

If you'd like to run the test suite to ensure Mace is functioning correctly, they can be run from ninja using:

$ ninja -C build test

Issues & Support

Please file any bugs or feature requests.

Contributing

The Mace developers welcomes contributions in the form of Pull Requests.

If you would like to contribute but don't know what to do look at the github issues. There is probably something to do.