diff --git a/docs/img/ue_425.png b/docs/img/ue_425.png new file mode 100644 index 0000000..edbe8a3 Binary files /dev/null and b/docs/img/ue_425.png differ diff --git a/docs/img/ue_screensize.png b/docs/img/ue_screensize.png new file mode 100644 index 0000000..5f98f02 Binary files /dev/null and b/docs/img/ue_screensize.png differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..dbfba74 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,27 @@ + + + + + µEMACS + + + +

µEMACS

+ + µEMACS (ue) based on uEmacs/PK (em) from + kernel.org. + Latest version built and tested on Cygwin, Ubuntu Linux and NetBSD. +

+ Quick build and install +

+ µEMACS sample screenshot + +


© 2020-2024 Renaud Fivet + + diff --git a/docs/quick.html b/docs/quick.html new file mode 100644 index 0000000..1b4f50a --- /dev/null +++ b/docs/quick.html @@ -0,0 +1,115 @@ + + + + + Quick µEMACS build and install + + + +

Quick µEMACS build and install

+ +

Dependencies and build environment

+ +To build µEMACS, you need to have gcc, GNU make and ncurses development +library installed. + +

Checking environment

+ +gcc and GNU make are often preinstalled with GNU make set as the default +make. Use your favorite package manager to check their availability. + +
+% which gcc make
+/usr/bin/gcc
+/usr/bin/make
+% apt list gcc make
+gcc/focal,now 4:9.3.0-1ubuntu2 amd64 [installed]
+make/focal,now 4.2.1-1.2 amd64 [installed]
+
+ +Use your favorite package manager if they need to be installed. + +
% sudo apt install gcc make
+ +To check that make is actually GNU make: + +
+% make --version
+GNU Make 4.2.1
+Built for x86_64-pc-linux-gnu
+Copyright (C) 1988-2016 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+
+ +ncurses development library usually need to be installed. Query your +favorite package manager to check which packages are available for +installation: + +
% apt search libncurses
+ +Use your favorite package manager to install the needed package: + +
% sudo apt install libncurses-dev
+ +On Ubuntu, apt will select the package that matches your architecture +(amd64 or i386). + +

Getting the sources

+ +µEMACS source code is available on +github and mirrored at +git.sdf.org. From github, you +can either clone the +git repository or download a +zip archive. +

+Move to working directory and clone: + +

+% mkdir ~/Projects
+% cd ~/Projects
+% git clone https://github.com/rfivet/uemacs.git
+
+ +

Building

+ +
+% cd ~/Projects/uemacs
+% make
+
+ +If GNU make is not set as the default make you will have to call it +explicitly + +
% gmake
+ +

Testing

+ +Start the editor: + +
% ./ue
+ +To leave the editor type CTL-X CTL-C +

+Execute a sample script: + +

% ./ue -x screensize.cmd
+ +Executing script screensize.cmd + +
© 2020-2024 Renaud Fivet + +