Skip to content

Commit 660fc45

Browse files
authored
Update README file for improved user experience (#71)
* Update README file for improved user experience The commit updates the Readme file with emojies, added new features, requirements and getting started sections. It also updates existing details. * Update README file for improved user experience The commit updates the Readme file with emojies, added new features, requirements and getting started sections. It also updates existing details. # Conflicts: # README.md
1 parent 808df1f commit 660fc45

File tree

1 file changed

+29
-17
lines changed

1 file changed

+29
-17
lines changed

README.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,40 @@
11
[![CI](https://github.com/tibagni/LogViewer/actions/workflows/main.yml/badge.svg)](https://github.com/tibagni/LogViewer/actions/workflows/main.yml)
22
[![Coverage Status](https://coveralls.io/repos/github/tibagni/LogViewer/badge.svg?branch=master)](https://coveralls.io/github/tibagni/LogViewer?branch=master)
3-
# LogViewer
4-
LogViewer is a simple tool to help you analyze Android logs.
5-
It allows you to analyze multiple log files at once and create (and apply) different filters on this set of log files showing a single filtered output differentiating each filter by a different color (defined by you)
3+
# LogViewer 💻📝🔍
4+
LogViewer is a simple tool to help you analyze Android logs. It allows you to analyze multiple log files at once and create (and apply) different filters on this set of log files showing a single filtered output differentiating each filter by a different color (defined by you).
65

7-
Check out more details on https://tibagni.github.io/LogViewer/
6+
Check out more details on [https://tibagni.github.io/LogViewer/](https://tibagni.github.io/LogViewer/).
87

9-
### Opening the project on IntelliJ
10-
Just open the project folder on IntelliJ or import it as a gradle project.
8+
## 💻 Features
9+
* 🔍 Analyze multiple log files at once
10+
* 🎨 Create and apply different filters on the set of log files, showing a single filtered output differentiating each filter by a different color (defined by you)
11+
* 🤖 Read bugreport information such as system properties, application packages, hidden system packages, carrier config, subscriptions etc.
12+
* 📝 Note the important log entries in my log view
13+
* ⏱️ Limit all logs by ignoring everything before or after a selected timestamp
14+
* 🛠️ Adjust the log viewer preferences to match your workflow
1115

12-
### Creating the JAR
13-
To create a JAR for LogViewer:
14-
./gradlew shadowJar\
15-
Output will be *build/libs/LogViewer-{version}-all.jar*
16+
## 📚 Requirements
17+
* Java 8 or later
18+
* Gradle (optional)
1619

17-
### Increasing app version
18-
To increase app version, change it on _app.properties_
19-
* _app.properties_ - This file is located on _src/main/resources/properties/app.properties_ and there is a symbolik link for it on root folder to make it easier to access
20+
## 🏠 Getting Started
21+
To get started with LogViewer, follow these steps:
22+
1. Clone this repository and open it in IntelliJ IDEA or any other Java development environment of your choice.
23+
2. Install the required dependencies by running `./gradlew install` on the command line.
24+
3. Build the application by running `./gradlew build` on the command line.
25+
4. Run the application by running `./gradlew run` on the command line.
26+
5. Use the UI to analyze log files and apply filters
2027

21-
### Running tests
22-
On IntelliJ, right click on 'test' folder (it is under 'src/test') and select "Run 'All Tests'"\
23-
Or run ./gradlew test
28+
## 📦 Creating a JAR File
29+
To create a JAR file for the project, you can use the `shadowJar` task provided by Gradle. Run `./gradlew shadowJar` on the command line to create a JAR file in the `build/libs` directory. The JAR file will be named `LogViewer-{version}-all.jar`, where `{version}` is the current version of the project.
2430

25-
# License
31+
## 📈 Increasing App Version
32+
To increase the app version, change it on `_app.properties_`. This file is located in `src/main/resources/properties/app.properties` and there is a symbolic link for it on the root folder to make it easier to access. You can use any text editor to edit this file, or you can use IntelliJ IDEA to open it and edit it directly from within the IDE.
33+
34+
## 🧪 Running Tests
35+
You can run tests on IntelliJ by right-clicking on the `test` folder (it is under `src/test`) and selecting "Run 'All Tests'". Alternatively, you can run `./gradlew test` on the command line to run all tests.
36+
37+
## 📄 License
2638
```
2739
MIT License
2840

0 commit comments

Comments
 (0)