Skip to content
This repository was archived by the owner on Apr 16, 2023. It is now read-only.

Commit 07e1b8f

Browse files
committed
* Workflow only on release and pushes to master
* Updated README.md with extra information
1 parent d62e48d commit 07e1b8f

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

.github/workflows/rust.yml

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ on:
66
push:
77
branches:
88
- master
9-
- development
109

1110
jobs:
1211
build:

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,21 @@
33
![GitHub release (latest by date)](https://img.shields.io/github/v/release/CodeDead/text-diff-rs)
44
![GitHub](https://img.shields.io/badge/language-Rust-green)
55
![GitHub](https://img.shields.io/github/license/CodeDead/text-diff-rs)
6+
[![Deploy](https://github.com/CodeDead/text-diff-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/CodeDead/text-diff-rs/actions/workflows/rust.yml)
67

78
![text-diff](https://i.imgur.com/VrcSyMD.png)
89

9-
`text-diff` can be used to compare two text files and output the difference between them. `text-diff` was written in `Rust` and offers a simple and intuitive user-interface for Windows, Linux and macOS.
10+
`text-diff` can be used to compare two text files and output the difference between them. `text-diff` was written
11+
in `Rust` and offers a simple and intuitive user-interface for Windows, Linux and macOS.
12+
13+
## Features
14+
15+
* Compare two text files
16+
* Display the differences between two text files
17+
* Export the differences to TXT, CSV or JSON
18+
* Written in [Rust](https://www.rust-lang.org/)
19+
* Cross-platform
20+
* Fully native binaries
1021

1122
## Building
1223

@@ -17,20 +28,24 @@ cargo build
1728
```
1829

1930
A `release` build with extra optimizations can be built by issuing the following command:
31+
2032
```shell
2133
cargo build --release
2234
```
2335

2436
### Tips
2537

26-
On `Linux` you can further decrease the binary size by issuing a `strip` command, which will 'strip' symbols from the object file:
38+
On `Linux` you can further decrease the binary size by issuing a `strip` command, which will 'strip' symbols from the
39+
object file, after building:
40+
2741
```shell
28-
strip filename
42+
cargo build --release && strip target/release/text-diff
2943
```
3044

3145
## Running
3246

3347
You can run `text-diff` directly by issuing the following command:
48+
3449
```shell
3550
cargo run
3651
```

0 commit comments

Comments
 (0)