diff --git a/README.md b/README.md index 222bdfe..eb0ae8b 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,54 @@ + # xcresults -A command line tool to extract test summaries & screenshots from Xcode 11 XCResult files. +**xcresults** is a command-line tool designed to extract test summaries and screenshots from XCResult files generated by Xcode 11. ## Installation -Download latest version from github releases: +### For M1 CPU (arm64) -`wget https://github.com/eroshenkoam/xcresults/releases/latest/download/xcresults` +1. Download the executable file: + ```bash + wget https://github.com/eroshenkoam/xcresults/releases/latest/download/xcresults + ``` +2. Make the file executable: + ```bash + chmod +x xcresults + ``` -And make it executable: +### For Intel CPU (i386) -`chmod +x xcresults` +1. Download the appropriate executable file: + ```bash + wget https://github.com/eroshenkoam/xcresults/releases/latest/download/xcresults-i386 -o xcresults + ``` +2. Make the file executable: + ```bash + chmod +x xcresults + ``` ## Usage -`xcresults ` - -Below are a few examples of common commands. For further assistance, use the --help option on any command +The general command format: +```bash +xcresults +``` +For further assistance on any command, use the `--help` option. -### Export to Allure2 results +### Exporting Results in Allure 2 Format -Single source: -`xcresults export /path/to/Test.xcresult -o /path/to/outputDirectory` +**For a single file:** +```bash +xcresults export /path/to/Test.xcresult -o /path/to/outputDirectory +``` -Multiple sources: -`xcresults export /path/to/First.xcresult /path/to/Second.xcresult -o /path/to/outputDirectory` +**For multiple files:** +```bash +xcresults export /path/to/First.xcresult /path/to/Second.xcresult -o /path/to/outputDirectory +``` -After that you can generate Allure report by following command: +After exporting, you can generate an Allure report with the following command: -`allure serve /path/to/outputDirectory` +```bash +allure serve /path/to/outputDirectory +```