Skip to content

Commit ac1b797

Browse files
committed
Updated with information on Air packaging
1 parent c8d9a79 commit ac1b797

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
11
SourceDiff
22
==========
33

4-
SourceDiff uses client-side javascript to generate a side-by-side diff of two text files. Line insertions, deletions, and modifications are indicated, each in a different color.
4+
SourceDiff uses javascript to generate a side-by-side diff of two text files. Line insertions, deletions, and modifications are indicated, each in a different color.
55

66
Here is an example diff for a css file:
77

88
<img src="diffExample.png">
99

10-
Notice that insertions show up on the right side in green. Deletions show up on the left side in red. Finally, modifications show up on both sides in yellow. Gray lines are used as padding to line up the text.
10+
Notice that insertions show up on the right side in green. Deletions show up on the left side in red. Finally, modifications show up on both sides in yellow. The exact changes are highlighted in light yellow. Gray lines are used as padding to line up the text.
1111

1212
Each side has its own set of scrollbars, but scrolling one will scroll the other in sync.
1313

14+
Using SourceDiff in the browser
15+
=========
16+
The file `diff.html` shows one example of how you can use SourceDiff in the browser. This file just has text areas where the original and edited files can be copied and pasted. Alternatively, the content could come from your web server.
17+
18+
Using SourceDiff on your desktop
19+
=========
20+
There are also deployment files to package up SourceDiff as an Adobe Air package. This provides a command-line interface to use the program on your desktop. This is especially useful for setting up SourceDiff as a diff tool in git, for example.
21+
22+
Command Line Arguments
23+
----------------
24+
The first argument is the path to the original file. The second argument is the path to the edited file. Paths may be either absolute or relative to the executing directory. Files are expected to have a UTF-8 encoding.
25+
26+
Creating the Air Package
27+
----------------
28+
To create the air package, download the Air SDK. `cd` into the `air` directory and run `airDeploy.bat`. When prompted, enter `sourcediff` as the password for the self-signed certificate.
29+
1430
Future enhancements:
1531
+ Syntax highlighting
1632
+ Buttons to navigate to previous and next difference

0 commit comments

Comments
 (0)