Skip to content

Commit c465cec

Browse files
author
sarthakpranesh
committed
Updated documentation, closes #3
Signed-off-by: sarthakpranesh <[email protected]>
1 parent 761a2d5 commit c465cec

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
1-
# CpuRoller (mini project)
2-
31
<div align="center">
42

5-
<img src="./sample.png" />
3+
# Cpu Roller
4+
5+
[![GitHub issues](https://img.shields.io/github/issues/sarthakpranesh/CpuRoller)](https://github.com/sarthakpranesh/CpuRoller/issues)
6+
[![GitHub pull requests](https://img.shields.io/github/issues-pr/sarthakpranesh/CpuRoller)](https://github.com/sarthakpranesh/CpuRoller/pulls)
7+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/sarthakpranesh/CpuRoller)]()
8+
[![GitHub All Releases](https://img.shields.io/github/downloads/sarthakpranesh/CpuRoller/total)](https://github.com/sarthakpranesh/CpuRoller/releases)
9+
[![GitHub](https://img.shields.io/github/license/sarthakpranesh/CpuRoller)](https://github.com/sarthakpranesh/CpuRoller/blob/master/LICENSE)
10+
11+
<br />
12+
13+
<img src="./sample.gif" />
614

715
</div>
816

917
<br />
1018

1119
## What it does
1220

13-
A simple Desktop application that shows realtime CPU usage of your machine. Uses React as frontend and Go lang as it's backend to achieving this.
21+
Simple Cross platform Desktop application for displaying realtime CPU usage of your Desktop/Laptop. Available for Linux and MacOS. Utilizes React.js frontend and Go lang backend, developed with Wails.
1422

1523
<br />
1624

@@ -28,7 +36,7 @@ Make sure you have GO lang and npm installed
2836

2937
1. `git clone https://github.com/sarthakpranesh/CpuRoller`
3038
2. `cd CpuRoller`
31-
3. If you don't have Wails then install it `go get -u github.com/wailsapp/wails/cmd/wails`
39+
3. If you don't have Wails then install it using the following command: `go get -u github.com/wailsapp/wails/cmd/wails`
3240
4. `wails serve` - leave the command running and open another terminal
3341
5. `cd frontend`
3442
6. `yarn install`
@@ -38,8 +46,8 @@ Make sure you have GO lang and npm installed
3846

3947
## Compile/Build/Package app
4048

41-
1. Compile application using `wails build`
42-
2. Run application `./build/cpuRoller`
49+
1. Compile application using: `wails build`
50+
2. Run compiled application from the `build` folder, eg: `./build/cpuRoller`
4351

4452
<br/>
4553

sample.gif

500 KB
Loading

sample.png

-48.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)