diff --git a/README b/README deleted file mode 100644 index 8c1bd70..0000000 --- a/README +++ /dev/null @@ -1,41 +0,0 @@ -General Information -=================== - -xed is a small and lightweight text editor. - -xed supports most standard editing features, plus several not found in your -average text editor (plugins being the most notable of these). - -Although new features are always under development, currently xed has: - - * Complete support for UTF-8 text - * Syntax highlighting - * Support for editing remote files - * Search and Replace - * Printing and Print Previewing Support - * File Revert - * A complete preferences interface - * Configurable Plugin system, with optional python support - -Some of the plugins, packaged and installed with xed include, among others: - - * Word count - * Spell checker - * Change case of selected text - * File Browser - * Sort - * Insert Date/Time - * Tag list - -xed is released under the GNU General Public License (GPL) version 2, see -the file 'COPYING' for more information. - -Installation -============ - -Simple install procedure: - - % meson . build # run the `configure' script - % ninja -v -C build # build xed - [ Become root if necessary ] - % ninja install -v -C build # install xed diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e7bfe5 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# Xed Text Editor + +xed is a small and lightweight text editor. + +xed supports most standard editing features, plus several not found in your +average text editor (plugins being the most notable of these). + +Although new features are always under development, currently xed has: + + * Complete support for UTF-8 text + * Syntax highlighting + * Support for editing remote files + * Search and Replace + * Printing and Print Previewing Support + * File Revert + * A complete preferences interface + * Configurable Plugin system, with optional python support + +Some of the plugins, packaged and installed with xed include, among others: + + * Change Case + * Document Statistics + * File Browser + * Indent Lines + * Insert Date/Time + * Modelines + * Save Without Trailing Spaces + * Sort + * Spell checker + * Tag list + * Word Completion + + +## Installation + + 1. run the 'configure' script + - **meson --prefix=/usr build ** + 2. build xed + - **ninja -v -C build** + 3. install xed *Become root if necessary* + - **ninja install -v -C build** + + *Build Instructions for Debian-based distros* + 1. run **dpkg-buildpackage** from the xed base directory + 2. **cd ..** + 3. **dpkg -i \*.deb** *Become root if necessary* + 4. From then, any new changes can be applied by running + - **ninja -C debian/build install** *Become root if necessary* + +### Xed look and feel + +##### Classic Mode +![classic-screenshot](/screencaptures/classic_screencapture.png?raw=true) + +##### Theme selections +![theme-screenshot](/screencaptures/theme_screencapture.png?raw=true) + +##### Search and Replace feature +![search-replace-screenshot](/screencaptures/search_replace_screencapture.png?raw=true) + +##### Select from several languages in Highlight syntax mode +![highlightmode-screenshot](/screencaptures/highlightmode_screencapture.png?raw=true) + +##### Xed Shortcuts +![shortcuts-1-screenshot](/screencaptures/shortcuts_1_screencapture.png?raw=true) +![shortcuts-2-screenshot](/screencaptures/shortcuts_2_screencapture.png?raw=true) + + + +> xed is released under the GNU General Public License (GPL) version 2, see +> the file 'COPYING' for more information. diff --git a/screencaptures/classic_screencapture.png b/screencaptures/classic_screencapture.png new file mode 100644 index 0000000..df80714 Binary files /dev/null and b/screencaptures/classic_screencapture.png differ diff --git a/screencaptures/highlightmode_screencapture.png b/screencaptures/highlightmode_screencapture.png new file mode 100644 index 0000000..e45e0d1 Binary files /dev/null and b/screencaptures/highlightmode_screencapture.png differ diff --git a/screencaptures/search_replace_screencapture.png b/screencaptures/search_replace_screencapture.png new file mode 100644 index 0000000..ac03da1 Binary files /dev/null and b/screencaptures/search_replace_screencapture.png differ diff --git a/screencaptures/shortcuts_1_screencapture.png b/screencaptures/shortcuts_1_screencapture.png new file mode 100644 index 0000000..93340c5 Binary files /dev/null and b/screencaptures/shortcuts_1_screencapture.png differ diff --git a/screencaptures/shortcuts_2_screencapture.png b/screencaptures/shortcuts_2_screencapture.png new file mode 100644 index 0000000..ed36bce Binary files /dev/null and b/screencaptures/shortcuts_2_screencapture.png differ diff --git a/screencaptures/theme_screencapture.png b/screencaptures/theme_screencapture.png new file mode 100644 index 0000000..d126eb4 Binary files /dev/null and b/screencaptures/theme_screencapture.png differ