Skip to content

Commit 43dda90

Browse files
committed
Updated documentation.
1 parent 2efedb6 commit 43dda90

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# File Diff
2-
---
32

43
Two-way file comparison for Textadept.
54

65
Install this module by copying it into your *~/.textadept/modules/* directory or Textadept's
76
*modules/* directory, and then putting the following in your *~/.textadept/init.lua*:
87

9-
require('file_diff')
8+
require('file_diff')
109

1110
## Compiling
1211

1312
Releases include binaries, so building this modules should not be necessary. If you want
1413
to build manually, use CMake. For example:
1514

16-
cmake -S . -B build_dir
17-
cmake --build build_dir --target diff
18-
cmake --install build_dir
15+
cmake -S . -B build_dir
16+
cmake --build build_dir --target diff
17+
cmake --install build_dir
1918

2019
## Usage
2120

@@ -25,10 +24,10 @@ A sample workflow is this:
2524
2. The caret is initially placed in the file on the left.
2625
3. Go to the next change via menu or key binding.
2726
4. Merge the change from the other buffer into the current one (right to left) via menu or
28-
key binding.
27+
key binding.
2928
5. Go to the next change via menu or key binding.
3029
6. Merge the change from the current buffer into the other one (left to right) via menu or
31-
key binding.
30+
key binding.
3231
7. Repeat as necessary.
3332

3433
Note: merging can be performed wherever the caret is placed when jumping between changes,
@@ -93,7 +92,7 @@ Parameters:
9392
Usage:
9493

9594
- `diffs = diff(text1, text2)
96-
for i = 1, #diffs, 2 do print(diffs[i], diffs[i + 1]) end
95+
for i = 1, #diffs, 2 do print(diffs[i], diffs[i + 1]) end
9796
`
9897

9998
Return:
@@ -128,11 +127,11 @@ Highlight differences between files *file1* and *file2*, or the user-selected fi
128127
Parameters:
129128

130129
- *file1*: Optional name of the older file. If `-`, uses the current buffer. If `nil`,
131-
the user is prompted for a file.
130+
the user is prompted for a file.
132131
- *file2*: Optional name of the newer file. If `-`, uses the current buffer. If `nil`,
133-
the user is prompted for a file.
132+
the user is prompted for a file.
134133
- *horizontal*: Optional flag specifying whether or not to split the view horizontally. The
135-
default value is `false`, comparing the two files side-by-side.
134+
default value is `false`, comparing the two files side-by-side.
136135

137136

138137
---

0 commit comments

Comments
 (0)