Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Completed the ReadMe
  • Loading branch information
amj0851 authored Sep 3, 2023
1 parent ee797df commit 6cd2a8c
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# SWE_HW_0
first/test project for SWE
# Highlighter

Highlighter is a small tool that highlights
leaf level GUI-components in an Android application screenshot by
parsing and processing xml files, thus making it easier for
developers to understand the GUI.

## Usage
Place the program file in the same folder as the xml files and the corresponding screenshots (in png format). Make sure that the xml files and the png files share the same name.

Compile and run the program using

```bash
python highlighter.py
```

The program will run on all xml files in the folder. If it encounters an error in an xml file, or cannot find a matching png, that file will be skipped.

Annotated PNG results will be saved to the same folder that the program is in.

0 comments on commit 6cd2a8c

Please sign in to comment.