Skip to content

Commit 4fde7e4

Browse files
author
Detlef Groth
committed
extended README-standalone and removed another README
1 parent a207c2c commit 4fde7e4

File tree

2 files changed

+82
-104
lines changed

2 files changed

+82
-104
lines changed

README-standalone.md

Lines changed: 82 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Readme for the Jasspa Microemacs Text Editor"
33
author: Detlef Groth
4-
date: 2024-08-23 11:51
4+
date: 2024-08-23 13:13
55
---
66

77
## Table of Contents
@@ -18,59 +18,65 @@ date: 2024-08-23 11:51
1818
- [Personal Directory](#Personal)
1919
- [Creating Your Profile](#Create)
2020
- [Company Profiles](#Company)
21+
- [Support](#Support)
2122

2223
<a name="Intro"> </a>
2324
## Introduction
2425

2526
The MicroEmacs 09 Text Editor is a small footprint text editor with the
2627
following features:
2728

28-
- single file small binary approx 2.5Mb
29+
- small single file binary approx 2.5Mb (with help file and American
30+
dictionary embedded)
2931
- fast startup and low memory footprint (less than 2Mb usually)
30-
- session management
31-
- extensible macro language
3232
- Emacs like editing
3333
- support for many programming and markup languages
34+
- extensible macro language
35+
- session management
3436
- sophisticated embedded hypertext help system
3537
- same interface for terminal and GUI application
3638
- many themes
3739
- menu AND shortcut enabled
38-
- cross platform same functionality MacOS, Linux and Windows (an others on
40+
- cross platform same functionality MacOS, Linux and Windows (many others on
3941
request)
4042
- easy embedding of other tools
4143

4244
The main cons:
4345

44-
- no Unicode support only ISO 8859-1 .. 15 amd Windows-Cp1252 support
45-
- converting Unicode to these code pages would be possible
46+
- no Unicode support - only ISO 8859-1 .. 15 amd Windows-Cp1252 support -
47+
because it is an __Micro__Emacs
48+
- but: converting Unicode to these code pages and back would be possible if
49+
really required
4650
- no softwrap facilities, wrap mode means automatically wrapping with newlines
4751

4852
<a name="Main"> </a>
4953
## Main files
5054

51-
As these builds are stand-aline files, installation is simply a copy operation
52-
on your file system after downloading. The following files provide the
55+
As these builds are stand-alone files, installation is simply a copy operation
56+
on your file system after downloading the release file. The following files provide the
5357
following functionality.
5458

5559
Mandatory:
5660

57-
- mecb.bin - the terminal version of the MicroEmacs 09, rename it to mec (mec.exe
61+
- _mecb.bin_ - the terminal version of the MicroEmacs 09, rename it to mec (mec.exe
5862
on Windows) and place it into a folder belonging to your PATH, contains as
5963
well the help file and the American dictionary files.
60-
- mewb.bin - the GUI version (mewb.exe), using X11 on Linux and MacOS, rename it
64+
- _mewb.bin_ - the GUI version (mewb.exe), using X11 on Linux and MacOS, rename it
6165
to mew (mew.exe on Windows) and place it into a folder belonging to your
6266
PATH, contains as well the help file and the American dictionary files.
6367

6468
Optional:
6569

66-
- X11 (Linux, MacOS): the _xfontsel_ tool for better font selection, installable
70+
- _mecw.bin_ - the combined terminal and GUI version which is only available
71+
for Unix systems like Linux and MacOS
72+
- _xfontsel_ - X11 tool (Linux, MacOS) for better font selection, installable
6773
via package manager (see below for details)
68-
- X11 (Linux, MacOS): ttf-files.zip selection of good looking TrueType fonts
74+
- _ttf-files.zip_ - for X11 (Linux, MacOS) selection of good looking TrueType fonts
6975
in a form usable for MicroEmacs and other X11 applications (can be as well
7076
installed for Windows)
71-
- X11 (Linux, MacOS) - the _mkfontscale_ tool to add your own TrueType font to
77+
- _mkfontscale_ - X11 (Linux, MacOS) tool to add your own TrueType font to
7278
be used with MicroEmacs
73-
- bfs.bin (bfs.exe) - an archiving tool which allows you to modify a
79+
- _bfs.bin_ (bfs.exe) - an archiving tool which allows you to modify a
7480
MicroEmacs executable for instance adding your own macro or dictionary files
7581

7682
Details about these components are following below.
@@ -104,17 +110,35 @@ The installation just follows these basic steps:
104110

105111
__Linux and MacOS:__
106112

107-
- create a folder ~/.jasspa in your home directory - this folder will keep
113+
- create a folder `~/.jasspa` in your home directory - this folder will keep
108114
your personal settings, macros, sessions etc
109-
- copy the mec (or mew) file as mec (mew) to the folder ~/.local/bin - this folder should
115+
- copy the _mec-VERSION-PLATFORM.bin_ (or _mew-VERSION-PLATFORM.bin_) file as
116+
mec (mew) to the folder `~/.local/bin` - this folder should
110117
usually belong to your PATH variable, if not add to the PATH variable in
111-
your ~/.bashrc or ~/.zshrc file like this: `export PATH=~/.local/bin:$PATH`
112-
- make the file executable using chmod 755 ~/.local/bin/me*
113-
- run the mec/mew executable and do do general setup and then the user setup
114-
"Esc x user-setup" by selecting the users keyboard
118+
your `~/.bashrc` or `~/.zshrc` file like this: `export PATH=~/.local/bin:$PATH`
119+
- make the file executable using `chmod 755 ~/.local/bin/me*`
120+
- run the mec/mew executable and do do general setup and then run the user setup
121+
"Esc x user-setup" or use the menu entry "Tools -> User Setup" by selecting
122+
the users keyboard
115123
- optionally install a few better looking TTF fonts in the users font folder
116124
(see below)
117125

126+
If you like to have support for colors in the terminal version you should
127+
check in the User-Setup in the Platform Tab the Termcap Color checkbox and
128+
start me with a redefined terminal varianle like this:
129+
130+
```
131+
TERM=rxvt mec
132+
```
133+
134+
It is advisible if this works on your terminal to make an alias in your shell
135+
configuration file like this:
136+
137+
```bash
138+
alias mec="TERM=rxvt mec"
139+
```
140+
141+
118142
__Windows:__
119143

120144
- if not yet existing - create a folder 'C:\Users\<Username>\bin'
@@ -127,6 +151,10 @@ __Windows:__
127151
- Add the path to your new directory (e.g., C:\Users\<Username>\bin) to the list of paths.
128152
- run the mec/mew executables (Win-r and typing mew<ENTER>) and do general setup giving your username and
129153
then the user setup "Esc x user-setup" mainly here selecting the right keyboard for your computer
154+
- If you after selecting the keyboard get an error about not having writing the
155+
_username.erf_ file you might to create the appropriate directory
156+
`~./jasspa` by yourself and then repeat the procedure. To use the spell-checking facilities you have
157+
to download and unpack the spell-checking files from here https://github.com/mittelmark/microemacs/releases/tag/v0.9.0
130158

131159
<a name="Fonts"> </a>
132160

@@ -609,3 +637,36 @@ directory. These would include:-
609637
* Extensions to the standard hook definitions (myXXX.emf) for
610638
company specific language extensions to the standard hook files.
611639
See File Hooks and File Language Templates.
640+
641+
<a name="Support"> </a>
642+
643+
## Support
644+
645+
__Issues:__
646+
647+
In case you find bugs or have suggestions for improvements or would like to
648+
port the code to other platforms use the Issues tab on the Github page:
649+
650+
[https://github.com/mittelmark/microemacs/issues](https://github.com/mittelmark/microemacs/issues)
651+
652+
__Help:___
653+
654+
MicroEmacs contains an embedded help system. Use the 'Help' menu entry on the
655+
right. There is as well a set of older HTML files online available from here:
656+
657+
658+
[http://www.jasspa.com/me.html](http://www.jasspa.com/me.html)
659+
660+
__Contact:__
661+
662+
In case of questions, suggestions, trouble etc, write to dgroth (at) uni
663+
(minus) potsdam (dot) de or use the issue tracker at the Github project page.
664+
665+
## Future
666+
667+
BTW: Currently a new release, named ME 2024, with more features (https, git)
668+
support, is prepared.
669+
670+
671+
672+

README.txt

Lines changed: 0 additions & 83 deletions
This file was deleted.

0 commit comments

Comments
 (0)