diff --git a/README-standalone.md b/README-standalone.md index c76ded0..da74ba8 100644 --- a/README-standalone.md +++ b/README-standalone.md @@ -1,7 +1,7 @@ --- title: "Readme for the Jasspa Microemacs Text Editor" author: Detlef Groth -date: 2024-08-23 11:51 +date: 2024-08-23 13:13 --- ## Table of Contents @@ -18,6 +18,7 @@ date: 2024-08-23 11:51 - [Personal Directory](#Personal) - [Creating Your Profile](#Create) - [Company Profiles](#Company) +- [Support](#Support) ## Introduction @@ -25,52 +26,57 @@ date: 2024-08-23 11:51 The MicroEmacs 09 Text Editor is a small footprint text editor with the following features: -- single file small binary approx 2.5Mb +- small single file binary approx 2.5Mb (with help file and American + dictionary embedded) - fast startup and low memory footprint (less than 2Mb usually) -- session management -- extensible macro language - Emacs like editing - support for many programming and markup languages +- extensible macro language +- session management - sophisticated embedded hypertext help system - same interface for terminal and GUI application - many themes - menu AND shortcut enabled -- cross platform same functionality MacOS, Linux and Windows (an others on +- cross platform same functionality MacOS, Linux and Windows (many others on request) - easy embedding of other tools The main cons: -- no Unicode support only ISO 8859-1 .. 15 amd Windows-Cp1252 support -- converting Unicode to these code pages would be possible +- no Unicode support - only ISO 8859-1 .. 15 amd Windows-Cp1252 support - + because it is an __Micro__Emacs +- but: converting Unicode to these code pages and back would be possible if + really required - no softwrap facilities, wrap mode means automatically wrapping with newlines ## Main files -As these builds are stand-aline files, installation is simply a copy operation -on your file system after downloading. The following files provide the +As these builds are stand-alone files, installation is simply a copy operation +on your file system after downloading the release file. The following files provide the following functionality. Mandatory: -- mecb.bin - the terminal version of the MicroEmacs 09, rename it to mec (mec.exe +- _mecb.bin_ - the terminal version of the MicroEmacs 09, rename it to mec (mec.exe on Windows) and place it into a folder belonging to your PATH, contains as well the help file and the American dictionary files. -- mewb.bin - the GUI version (mewb.exe), using X11 on Linux and MacOS, rename it +- _mewb.bin_ - the GUI version (mewb.exe), using X11 on Linux and MacOS, rename it to mew (mew.exe on Windows) and place it into a folder belonging to your PATH, contains as well the help file and the American dictionary files. Optional: -- X11 (Linux, MacOS): the _xfontsel_ tool for better font selection, installable +- _mecw.bin_ - the combined terminal and GUI version which is only available + for Unix systems like Linux and MacOS +- _xfontsel_ - X11 tool (Linux, MacOS) for better font selection, installable via package manager (see below for details) -- X11 (Linux, MacOS): ttf-files.zip selection of good looking TrueType fonts +- _ttf-files.zip_ - for X11 (Linux, MacOS) selection of good looking TrueType fonts in a form usable for MicroEmacs and other X11 applications (can be as well installed for Windows) -- X11 (Linux, MacOS) - the _mkfontscale_ tool to add your own TrueType font to +- _mkfontscale_ - X11 (Linux, MacOS) tool to add your own TrueType font to be used with MicroEmacs -- bfs.bin (bfs.exe) - an archiving tool which allows you to modify a +- _bfs.bin_ (bfs.exe) - an archiving tool which allows you to modify a MicroEmacs executable for instance adding your own macro or dictionary files Details about these components are following below. @@ -104,17 +110,35 @@ The installation just follows these basic steps: __Linux and MacOS:__ -- create a folder ~/.jasspa in your home directory - this folder will keep +- create a folder `~/.jasspa` in your home directory - this folder will keep your personal settings, macros, sessions etc -- copy the mec (or mew) file as mec (mew) to the folder ~/.local/bin - this folder should +- copy the _mec-VERSION-PLATFORM.bin_ (or _mew-VERSION-PLATFORM.bin_) file as + mec (mew) to the folder `~/.local/bin` - this folder should usually belong to your PATH variable, if not add to the PATH variable in - your ~/.bashrc or ~/.zshrc file like this: `export PATH=~/.local/bin:$PATH` -- make the file executable using chmod 755 ~/.local/bin/me* -- run the mec/mew executable and do do general setup and then the user setup - "Esc x user-setup" by selecting the users keyboard + your `~/.bashrc` or `~/.zshrc` file like this: `export PATH=~/.local/bin:$PATH` +- make the file executable using `chmod 755 ~/.local/bin/me*` +- run the mec/mew executable and do do general setup and then run the user setup + "Esc x user-setup" or use the menu entry "Tools -> User Setup" by selecting + the users keyboard - optionally install a few better looking TTF fonts in the users font folder (see below) +If you like to have support for colors in the terminal version you should +check in the User-Setup in the Platform Tab the Termcap Color checkbox and +start me with a redefined terminal varianle like this: + +``` +TERM=rxvt mec +``` + +It is advisible if this works on your terminal to make an alias in your shell +configuration file like this: + +```bash +alias mec="TERM=rxvt mec" +``` + + __Windows:__ - if not yet existing - create a folder 'C:\Users\\bin' @@ -127,6 +151,10 @@ __Windows:__ - Add the path to your new directory (e.g., C:\Users\\bin) to the list of paths. - run the mec/mew executables (Win-r and typing mew) and do general setup giving your username and then the user setup "Esc x user-setup" mainly here selecting the right keyboard for your computer +- If you after selecting the keyboard get an error about not having writing the + _username.erf_ file you might to create the appropriate directory + `~./jasspa` by yourself and then repeat the procedure. To use the spell-checking facilities you have + to download and unpack the spell-checking files from here https://github.com/mittelmark/microemacs/releases/tag/v0.9.0 @@ -609,3 +637,36 @@ directory. These would include:- * Extensions to the standard hook definitions (myXXX.emf) for company specific language extensions to the standard hook files. See File Hooks and File Language Templates. + + + +## Support + +__Issues:__ + +In case you find bugs or have suggestions for improvements or would like to +port the code to other platforms use the Issues tab on the Github page: + +[https://github.com/mittelmark/microemacs/issues](https://github.com/mittelmark/microemacs/issues) + +__Help:___ + +MicroEmacs contains an embedded help system. Use the 'Help' menu entry on the +right. There is as well a set of older HTML files online available from here: + + +[http://www.jasspa.com/me.html](http://www.jasspa.com/me.html) + +__Contact:__ + +In case of questions, suggestions, trouble etc, write to dgroth (at) uni +(minus) potsdam (dot) de or use the issue tracker at the Github project page. + +## Future + +BTW: Currently a new release, named ME 2024, with more features (https, git) +support, is prepared. + + + + diff --git a/README.txt b/README.txt deleted file mode 100644 index ca2f04d..0000000 --- a/README.txt +++ /dev/null @@ -1,83 +0,0 @@ -> -!- document; sectioned -!- -> Author: Detlef Groth -> Created: 2023-10-30 -> Modified: <20240324.0820> - - -01) INTRODUCTION - -This document describes as short as possible the installation of Jasspa -MicroEmacs 09 and the first steps for the user setup. MicroEmacs is a small -footprint text editor which can be used in the terminal and as (X)-Window -application on Linux, macOS and Windows systems. It offers Emacs like coding, -syntax highlighting, user defined macro system, help system and much more in a -standalone single file executable. - -02) INSTALLATION - -The MicroEmacs executable is named either 'mecb' (or 'mecb.exe' for Windows) for a -console only version or 'mewb' (or 'mewb.exe' for Windows) for an (X)-Windows -version of the application. - -You can just make the file executable (on Unix like: 'chmod 755 mecb') and -copy then the file(s) to a folder belonging to your PATH variable. For instance -in '~/bin'. To store your user sessions you might as well create a folder -'~/.jasspa' within your HOME directory on Unix system (Linux, macOS) or a -folder jasspa in your users directory on Windows. - -I usually rename the file mewb just to me and the file mecb to mec to simplify -the execution. Hint: the mewb file can be as well executed as a terminal -command just giving the '-n' option, so writing 'mewb -n'. - -03) CONFIGURATION - -If you run the application for the first time you should configure the -keyboard and optionally the spell checking. It is recommend that you start -this with the window version of me ('mewb' or 'mewb.exe'). For this you either -execture the command user-setup directly by pressing 'Esc x' and then entering -'user-setup' and the ENTER key or using the menu entry 'Tools->User setup' and -there using the 'Start-Up' tab. At the bottom choose your keyboard layout. If -your language is not supported open an issue at the Github project page. - -https://github.com/mittelmark/microemacs/issues - -If you after selecting the keyboard get an error about not having writing the -username.erf file you might to create the appropriate directory by yourself -and then repeat the procedure. To use the spell-checking facilities you have -to download and unpack the spell-checking files from here - -https://github.com/mittelmark/microemacs/releases/tag/v0.9.0 - -and place them into your user configuration file for instance '~/.jasspa' on -Unix systems. Afterwards you should be able to select a spell-checking -language. The application should already contain the American-English -dictionary so you can use this spell checking facility without downloading -additional files. - -If you have issues with running the terminal application in color mode, try to -execute the mecb executable like this: - - TERM=vt100 mecb - -If this is not sufficient check that in the 'user-setup' in the 'Platform' tab -the 'Termcap color' option is selected. If this is done restart the -application. - -04) HELP - -MicroEmacs contains an embedded help system. Use the 'Help' menu entry on the -right. There is as well a set of older HTML files online available from here: - -http://www.jasspa.com/me.html - -05) Future - -Currently a new release, named ME 2024, with more features (https, git) -support, is prepared. - -06) Contact - -In case of questions, suggestions, trouble etc, write to dgroth (at) uni -(minus) potsdam (dot) de or use the issue tracker at the Github project page. - -