Skip to content

Commit 0188afc

Browse files
committed
Add README and screenshots
This commit introduces the project's README.md file, providing an overview of Diffly, its features, inspiration, and instructions for getting started. It also includes screenshots to showcase the application's user interface. - Added `README.md` with sections for: - Project description - Features - Inspiration (Diffchecker Text Compare) - Screenshots - Diff detection algorithm explanation - Getting Started instructions - Contributing guidelines - License (MIT) - Added screenshot files in the `ART/` directory: - `ART1.jpg`, `ART2.jpg`, `ART3.jpg` (original aspect ratio) - `ART1-portrait.png`, `ART2-portrait.png`, `ART3-portrait.png` (portrait aspect ratio for README)
1 parent c34f1c9 commit 0188afc

File tree

7 files changed

+56
-0
lines changed

7 files changed

+56
-0
lines changed

ART/ART1-portrait.png

1020 KB
Loading

ART/ART1.jpg

765 KB
Loading

ART/ART2-portrait.png

454 KB
Loading

ART/ART2.jpg

277 KB
Loading

ART/ART3-portrait.png

299 KB
Loading

ART/ART3.jpg

136 KB
Loading

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Diffly
2+
3+
Diffly is a text comparison tool built in Kotlin, inspired by the functionality and user experience of [Diffchecker Text Compare](https://www.diffchecker.com/text-compare/). This project provides an easy-to-use interface for comparing two pieces of text and visualizing their differences efficiently.
4+
5+
## Features
6+
7+
- Compare two blocks of text and highlight their differences.
8+
- Clean and user-friendly interface.
9+
- Fast and accurate diffing algorithm.
10+
- 100% Kotlin codebase.
11+
12+
## Inspiration
13+
14+
This project is inspired by [Diffchecker Text Compare](https://www.diffchecker.com/text-compare/), a popular web-based tool for comparing text files. Diffly seeks to provide similar capabilities in a standalone, open-source project.
15+
16+
## Screenshots
17+
18+
| Screenshot 1 | Screenshot 2 | ScreenSshot 3 |
19+
|-----------------------|----------------------|----------------------|
20+
| ![Screenshot 1](ART/ART1-portrait.png) | ![Screenshot 2](ART/ART2-portrait.png) | ![Screenshot 3](ART/ART3-portrait.png) |
21+
22+
23+
## Detect Algorithm
24+
25+
Diffly uses a diff detection algorithm to efficiently and accurately highlight differences between two text inputs. The algorithm typically works by:
26+
27+
1. **Splitting the input** into lines or words, depending on the granularity required.
28+
2. **Comparing sequences** using a variation of the Longest Common Subsequence (LCS) algorithm. This helps to detect added, removed, and changed blocks in the input texts.
29+
3. **Marking differences** by assigning segments as "added", "removed", or "unchanged", which are then highlighted accordingly in the UI.
30+
31+
While the core approach is inspired by standard diff algorithms, the implementation in Kotlin is optimized for performance and readability. This ensures that even large texts can be compared swiftly and results are easy to interpret.
32+
33+
## Getting Started
34+
35+
1. **Clone the repository:**
36+
```bash
37+
git clone https://github.com/JahidHasanCO/diffly.git
38+
```
39+
40+
2. **Open with your preferred Kotlin IDE (e.g., IntelliJ IDEA).**
41+
42+
3. **Build & Run:**
43+
- Follow the standard Kotlin project setup for your environment.
44+
- Run the main application file as defined in the source code.
45+
46+
## Contributing
47+
48+
Contributions are welcome! Please fork the repository and submit pull requests for any enhancements or bug fixes.
49+
50+
## License
51+
52+
This project is licensed under the MIT License.
53+
54+
---
55+
56+
**Note:** This project is not affiliated with Diffchecker; it is an open-source, independent reimplementation inspired by their public text comparison tool.

0 commit comments

Comments
 (0)