Skip to content

Commit 31c3195

Browse files
Update README.md
1 parent bb5aac6 commit 31c3195

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

README.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,47 @@
22

33
## Description
44

5-
This Julia package displays CPU and RAM memory usage information on your computer.
5+
This Julia package displays CPU and RAM usage information on your computer.
66

77
## Installation
88

99
### Step 1. Install Julia
1010

1111
#### macOS or Linux
1212

13+
To install Julia on macOS or Linux, run the following command in your terminal:
14+
1315
```sh
1416
$ curl -fsSL https://install.julialang.org | sh
1517
```
1618

17-
####
19+
#### Windows
20+
21+
For Windows, you can install Julia using the following command in PowerShell:
1822

1923
```powershell
2024
PS> winget install julia -s msstore
25+
After installation, you can confirm Julia is installed by running:
2126
```
2227

23-
You can run `julia --version` to confirm Julia is installed on your computer.
28+
```sh
29+
$ julia --version
30+
```
2431

32+
### Step 2. Download the source code
2533

26-
### Step 2. Download source code
34+
Clone the repository and navigate to the directory:
2735

28-
```sh
36+
```
37+
sh
2938
$ git clone https://github.com/AtelierArith/TerminalSystemMonitor.jl.git
3039
$ cd TerminalSystemMonitor.jl
3140
```
3241

3342
### Step 3. Resolve dependencies
43+
To resolve dependencies, ensure you are in the correct directory, then activate the Julia environment and instantiate the project:
3444

35-
```
45+
```sh
3646
$ pwd
3747
path/to/TerminalSystemMonitor.jl
3848
$ ls
@@ -43,15 +53,17 @@ julia> using Pkg; Pkg.activate("."); Pkg.instantiate()
4353

4454
## Usage
4555

56+
Run the program using the following commands:
57+
4658
```sh
4759
$ ls
4860
Project.toml README.md main.jl src
4961
$ julia main.jl
5062
```
5163

52-
You will get the following output like this:
64+
You will see an output similar to this:
5365

54-
```
66+
```bash
5567
──────────────────────╮╭──────────────────────╮
5668
│ ┌ ┐││ ┌ ┐│
5769
│id: 0┤■■■■ 37 ││id: 4┤■■ 23.2 │
@@ -75,26 +87,28 @@ You will get the following output like this:
7587
╰──────────────────────╯
7688
```
7789

78-
Ofcourse, you can launch the functionality in your terminal.
90+
Alternatively, you can launch the functionality directly from Julia:
7991

8092
```julia
8193
julia> using TerminalSystemMonitor: main; main()
8294
```
8395

84-
## Why not htop?
96+
## Why not `htop`?
8597

86-
You might think of the `htop' command. Yes, you can:
98+
You might be familiar with the `htop` command, which provides similar functionality. You can use `htop` in Julia as follows:
8799

88100
```julia
89101
julia> using Htop_jll; run(Htop_jll.htop())
90102
```
91103

92-
However, [Htop_jll](https://github.com/JuliaBinaryWrappers/Htop_jll.jl?tab=readme-ov-file#platforms) only supports Unix systems. Our Julia package runs on Windows as long as Term.jl and UnicodePlots.jl support Windows.
104+
However, `Htop_jll` only supports Unix-based systems. The TerminalSystemMonitor.jl package also supports Windows as long as Term.jl and UnicodePlots.jl are available on the platform.
93105

94-
## Why not bottom?
106+
## Why not `bottom`?
95107

96-
It's possible. We could use [bottom](https://github.com/ClementTsang/bottom) a.k.a `btm` command.
108+
You can also use bottom, also known as the btm command:
97109

98-
```sh
110+
```
99111
btm -b
100112
```
113+
114+
However, TerminalSystemMonitor.jl offers a cross-platform solution that integrates directly with Julia, providing similar functionality in a familiar environment.

0 commit comments

Comments
 (0)