Added screen captures to README. Changed README to README.md and added markdown. Updated README with plugins and debian build instructions.

This commit is contained in:
icarter09 2020-03-24 22:58:44 -04:00 committed by Michael Webster
parent 6f58fd2f2c
commit c8a0150fd4
8 changed files with 71 additions and 41 deletions

41
README
View File

@ -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

71
README.md Normal file
View File

@ -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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 326 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 251 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB