Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
berkaygediz authored Jul 5, 2024
1 parent a580153 commit 9ed8ee2
Showing 1 changed file with 35 additions and 40 deletions.
75 changes: 35 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,60 @@
# RichSpan - A Word Processor
# RichSpan - A Lightweight Word Processor
![Screenshot](richspan_banner_1.png)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/berkaygediz/richspan)
![GitHub repo size](https://img.shields.io/github/repo-size/berkaygediz/richspan)
![GitHub](https://img.shields.io/github/license/berkaygediz/richspan)

RichSpan is a word processor. Lightweight and easy to use, it is designed to be a simple alternative to other word processors. It is written in Python and uses the PyQt5 library for the graphical user interface. It is cross-platform and can be used on Windows, macOS, and Linux.

## Screenshots

![Screenshot](richspan_banner_1.png)

### Features

- [x] Cross-platform
- [x] Statistics
- [x] Find & replace
- [x] Print (Export to PDF)
- [x] Open and save .txt, .html, and .rsdoc (RichSpan Document) files
- [x] Text color/background color, bold, italic, underline, alignment, font, font size, and font color
- [x] Undo and redo
- [x] Drag and drop
- [x] Base64 image support
- [x] Customizable toolbar
- [x] Fast and lightweight
- [x] Threading support
- [x] Unsaved changes warning
- [x] Dark mode
- [x] Multi language (English, Turkish, German, Spanish, Azerbaijani)
- [x] Enumaration and bullet list
- [x] Power saver
- [x] Hardware acceleration

### Prerequisites
RichSpan is a lightweight word processor designed as a simple alternative to traditional word processing software. It is written in Python with a graphical user interface based on PyQt5, ensuring cross-platform compatibility across Windows, macOS, and Linux.

## Features
- [x] **Cross-Platform**: Compatible with Windows, macOS, and Linux.
- [x] **Statistics**: Provides statistical information about the document.
- [x] **Find & Replace**: Search and replace functionality within the document.
- [x] **Printing**: Allows print or exporting documents to PDF format.
- [x] **Document Operations**: Supports .txt, .html, and .rsdoc (RichSpan Document) file formats.
- [x] **Text Formatting**: Customize text with color, background color, bold, italic, underline, alignment, font, font size, and font color.
- [x] **Undo and Redo**: Provides undo and redo functionalities for editing operations.
- [x] **User Experience**: Features drag and drop functionality, supports dark mode, and provides alerts for unsaved changes.
- [x] **Base64 Image Support**: Supports embedding images using Base64 encoding.
- [x] **Customizable Toolbar**: Allows customization of the user interface toolbar.
- [x] **Performance**: Fast and lightweight with threading support and hardware acceleration.
- [x] **Multilingual**: Available in English, Turkish, German, Spanish, Azerbaijani.
- [x] **Enumeration and Bullet List**: Includes support for creating numbered and bulleted lists.
- [x] **Power Saver**: Optimized for power consumption.

## Prerequisites

- Python 3.6+
- PyQt5

### Installation
## Installation

1. Open a terminal and clone the repository:
1. Clone the repository:

```bash
git clone https://github.com/berkaygediz/RichSpan.git
```
```bash
git clone https://github.com/berkaygediz/RichSpan.git
```

2. Install requirements:

```bash
pip install -r .\requirements.txt
```
```bash
pip install -r requirements.txt
```

## Usage

### Usage
Launch RichSpan from the command line:

```bash
python RichSpan.py
```

## Contributing

Contributions to the RichSpan project are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
Contributions to the RichSpan project are welcomed. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute and our code of conduct.

## License

This project is licensed under the GNU GPLv3, GNU LGPLv3 & Mozilla Public License Version 2.0.
This project is licensed under GNU GPLv3, GNU LGPLv3, and Mozilla Public License Version 2.0.

0 comments on commit 9ed8ee2

Please sign in to comment.