git.mutantstargoat.com Git - visor/blob - README.md

   1 visor text editor & text editor framework
   2 =========================================
   3
   4 About
   5 -----
   6 *visor* is a lightweight, system-independent, device-independent, maximally
   7 portable, easily embeddable text editor framework. *visor* is also a concrete
   8 implementation of a text editor for a number of systems, based on the visor
   9 framework.
  10
  11 To avoid confusion, from this point forward we'll refer to the framework as
  12 `libvisor`, and the editor as `visor`, but keep in mind that the main focus of
  13 this project is actually the editor framework, and not the editor program.
  14
  15 Libvisor implements all the functionality needed by a complete text editor.
  16 From low level text manipulation operations, to (optional) high level user
  17 interaction layered onto those low level operations, designed to operate similar
  18 to the `vi` text editor. All the while maintaining complete system independence,
  19 able to operate (with help from the client application) under any operating
  20 system, or completely freestanding for embedded devices, boot loaders,
  21 exokernels, retro hacking, or bare metal programs.
  22
  23 For details about each component, see the `README.md` files in their
  24 subdirectories.
  25
  26 License
  27 -------
  28 Copyright (C) 2019 John Tsiombikas <nuclear@member.fsf.org>
  29 All parts of the visor project are free software. Feel free to use, modify,
  30 and/or redistribute under the terms of their respective licenses.
  31
  32  - *libvisor* (the framework) is released under the terms of the GNU Lesser
  33    General Public License (LGPL) version 3 or later. See `libvisor/COPYING` and
  34    `libvisor/COPYING.LESSER` for details.
  35
  36  - *visor* (the editor program) is released under the terms of the GNU General
  37    Public License (GPL) version 3 or later. See `visor/COPYING` for details.
  38
  39 Download
  40 --------
  41 The source code for both parts of the visor project are included in the same git
  42 repository, and released as one.
  43
  44 No releases are available yet, but you can grab the current source code from
  45 github: https://github.com/jtsiomb/visor