Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 2.82 KB

README.md

File metadata and controls

103 lines (71 loc) · 2.82 KB
Raw

Emacsy

Emacsy is an embeddable Emacs-like library for GNU Guile Scheme. It was a kickstarter project. It is now a Google Summer of Code 2013 project. I will be working with Ludovic Courtès from the GNU Project. Keep abreast of its development by watching this repository or following me on twitter @shanecelis.

WARNING

This project is currently in development. It is as alpha as can be. Not meant for general consumption yet. Contributors, welcome.

Dependencies

  • GNU Guile Scheme 2.0

  • guile-lib

  • Only necessary if building from github

    • Noweb

    • pdflatex

    • automake >= v1.14

      If you get an error saying that "warning: macro 'AM_EXTRA_RECURSIVE_TARGETS' not found in library", this means your version of automake is too old. (Alternatively, you can comment out the AM_EXTRA_RECURSIVE_TARGETS in configure.ac.)

    • autoconf >= v2.69

Building from a release (easy)

$ wget https://github.com/shanecelis/emacsy/releases/download/v0.1.1/emacsy-0.1.1.tar.gz
$ tar xfz emacsy-0.1.1.tar.gz
$ cd emacsy-0.1.1
$ ./configure
$ make

Building from github (harder)

$ git clone https://github.com/shanecelis/emacsy.git
$ cd emacsy/example
$ git clone https://github.com/shanecelis/hello-emacsy.git
$ git clone https://github.com/shanecelis/emacsy-webkit-gtk.git
$ cd ..
$ ./autogen.sh
$ ./configure
$ make

Running

Run the minimal example program and the barebones webkit browser example.

$ make run

minimal example screenshot

Reading

This is a literate program, so you can read it.

$ make show-doc

The literate documents are bundled in the distribution as emacys.pdf and hello-emacsy-paper.pdf.

Running Tests

$ make check

TODO

Lots to do. See the todo.org file.

License

Emacsy is available under the GNU GPLv3+. See the bundled LICENSE file for details.