aboutsummaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README48
1 files changed, 30 insertions, 18 deletions
diff --git a/README b/README
index cbe31cb..4991106 100644
--- a/README
+++ b/README
@@ -4,7 +4,6 @@
Overview
========
-<img align="left" alt="SciTECO" src="ico/sciteco-48.png"/>
SciTECO is an interactive TECO dialect, similar to Video TECO.
It also adds features from classic TECO-11, as well as unique new ideas.
@@ -17,8 +16,10 @@ as far as possible. For instance, moving the cursor to the right can be done imm
When you delete a character from the end of the command line macro (called rubout), the
side-effects of that character which may be a command or part of a command, are undone.
-SciTECO uses the [Scintilla](http://www.scintilla.org/) editor component and supports
-GTK+ 3 as well as Curses frontends (using [Scinterm](http://foicica.com/scinterm/)).
+![SciTECO demo](https://sciteco.sf.net/screenshots/v2.1-dev-freebsd-ncurses.gif)
+
+SciTECO uses the [Scintilla](https://www.scintilla.org/) editor component and supports
+GTK+ 3 as well as Curses frontends (using [Scinterm](https://foicica.com/scinterm/)).
The Curses frontend is verified to work with [ncurses](https://www.gnu.org/software/ncurses/),
[NetBSD Curses](https://github.com/sabotage-linux/netbsd-curses),
@@ -53,7 +54,8 @@ Features
the command stream.
This also enables navigating with function keys (e.g. cursor keys) as demonstrated
by the standard library `fnkeys.tes`.
- Function key macros can be context-sensitive, too.
+ In fact, all keys with printable representation and control keys can be remapped using
+ key macros - and they can be context-sensitive as well!
* Many TECO-11 features, like that most commands have a colon-modified form, string-building
characters, exotic match characters...
* Interactivity: Immediate searching (similar to search-as-you-type) and
@@ -73,8 +75,13 @@ Features
* Munging: Macros may be munged, that is executed in batch mode. In other words, SciTECO
can be used for scripting.
By default, a profile is munged.
-* 8-bit clean: SciTECO can be used to edit binary files if automatic EOL conversion
- is turned off (`16,0ED`).
+* Full Unicode (UTF-8) support: The document is still represented as a random-accessible
+ codepoint sequence.
+ While SciTECO macros can be written in plain ASCII - even in its printable subset -
+ Unicode glyphs can be used everywhere, where a single character is accepted, for instance
+ in single letter Q-Register names.
+* 8-bit clean: SciTECO can be used to edit binary files if the encoding is changed to
+ ANSI and automatic EOL conversion is turned off (easiest with `--8bit`).
* Self-documenting: An integrated indexed help system allows browsing formatted documentation
about commands, macros and concepts within SciTECO (`?` command).
Macro packages can be documented with the `tedoc` tool, generating man pages.
@@ -104,35 +111,40 @@ Download
There are prebuilt binary packages and source bundles for your convenience:
-* [Download Archive at Sourceforge](https://sourceforge.net/projects/sciteco/files/)
* [Github Releases](https://github.com/rhaberkorn/sciteco/releases)
+* [Download Archive at Sourceforge](https://sourceforge.net/projects/sciteco/files/)
* [Ubuntu PPA](https://launchpad.net/~robin-haberkorn/+archive/sciteco)
+* [Arch User Repository](https://aur.archlinux.org/packages/sciteco-git)
* Users of OpenWrt may try to install the
[`sciteco` package of this feed](https://github.com/rhaberkorn/nanonote-ports).
* Yocto/OpenEmbedded users should try the
[`sciteco` package from this layer](https://github.com/rhaberkorn/meta-rhaberkorn).
* [Chocolatey package](https://community.chocolatey.org/packages/SciTECO)
for Windows users.
-* The official [SciTECO homepage](http://sciteco.sf.net/) is a live demo.
-These releases may be quite outdated, so you may also try out the
-[nightly builds](https://github.com/rhaberkorn/sciteco/releases/tag/nightly) -
+These releases may be quite outdated and not all of them are provided or tested by the author.
+So you may also try out the [nightly builds](https://github.com/rhaberkorn/sciteco/releases/tag/nightly) -
they represent the repository's HEAD commit but may well be unstable.
-Both ncurses and Gtk+ packages are provided both for Ubuntu and Windows.
+Both ncurses and Gtk+ packages are provided for Ubuntu, generic Linux
+(in the form of [AppImages](https://appimage.org/)) and Windows.
For [Mac OS X](https://github.com/rhaberkorn/sciteco/wiki/Mac-OS-Support),
we currently only provide *experimental* ncurses builds.
If everything fails, you can try building from source.
-See [`INSTALL`](INSTALL) for more details.
+See [`INSTALL`](https://github.com/rhaberkorn/sciteco/blob/master/INSTALL) for more details.
Additional Documentation
========================
* Online manpages:
- [__sciteco__(1)](http://sciteco.sf.net/manuals/sciteco.1.html),
- [__sciteco__(7)](http://sciteco.sf.net/manuals/sciteco.7.html),
- [__grosciteco.tes__(1)](http://sciteco.sf.net/manuals/grosciteco.tes.1.html),
- [__tedoc.tes__(1)](http://sciteco.sf.net/manuals/tedoc.tes.1.html)
+ [__sciteco__(1)](https://rhaberkorn.github.io/sciteco/sciteco.1.html),
+ [__sciteco__(7)](https://rhaberkorn.github.io/sciteco/sciteco.7.html),
+ [__grosciteco.tes__(1)](https://rhaberkorn.github.io/sciteco/grosciteco.tes.1.html),
+ [__tedoc.tes__(1)](https://rhaberkorn.github.io/sciteco/tedoc.tes.1.html)
+* [Cheat Sheet and Language Overview](https://sciteco.sf.net/manuals/cheat-sheet.pdf).
+ This can be printed on an A4 sheet of paper.
* [Wiki at Github](https://github.com/rhaberkorn/sciteco/wiki)
-* A [short presentation](http://sciteco.sf.net/manuals/presentation.pdf)
- (in German!) hold at [Netz39](http://www.netz39.de/).
+* A [short presentation](https://sciteco.sf.net/manuals/presentation.pdf)
+ (in German!) hold at [Netz39](https://www.netz39.de/).
+
+<p align="center"><img alt="SciTECO icon" src="https://github.com/rhaberkorn/sciteco/raw/master/ico/sciteco-48.png"/></p>