Skip to content

Commit 13a7760

Browse files
author
Lapp
committed
project: change README.md and Makefile
1 parent be11068 commit 13a7760

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

Makefile

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
.SILENT:
33

44
setup-arm64:
5-
sudo mv ./build/bin/cleansys-arm64 /usr/local/bin/cleansys
5+
sudo mkdir -p /usr/local/bin \
6+
&& sudo mv ./build/bin/cleansys-arm64 /usr/local/bin/cleansys
67

78
setup-amd64:
8-
sudo mv ./build/bin/cleansys-amd64 /usr/local/bin/cleansys
9+
sudo mkdir -p /usr/local/bin \
10+
&& sudo mv ./build/bin/cleansys-amd64 /usr/local/bin/cleansys
911

1012
build-arm64:
1113
GOOS=darwin GOARCH=arm64 go build -o ./build/bin/cleansys-arm64 main.go

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
# Cleansys [![Go](https://img.shields.io/badge/go-1.17-blue)](https://golang.org/doc/go1.17) [![Release](https://img.shields.io/badge/release-1.0.0-success)](https://github.com/Lapp-coder/cleansys/releases)
22
![image](images/cleansys.png)
33
***
4-
## Install
5-
* ```
4+
## Installation
5+
1. Clone the repository
6+
```
67
$ git clone https://github.com/Lapp-coder/cleansys
78
```
9+
2. Go to the directory of the utility
10+
```
11+
$ cd cleansys
12+
```
13+
3. Execute the make command depending on the architecture of your processor
814
* For M1-chip:
915
```
10-
$ make setup-arm64
16+
$ chmod +x build/bin/cleansys-arm64 && make setup-arm64
1117
```
1218
* For Intel-chip:
1319
```
14-
$ make setup-amd64
20+
$ chmod +x build/bin/cleansys-amd64 && make setup-amd64
1521
```
1622
## Usage
17-
### Just run this command
23+
Just run this command
1824
```
1925
$ cleansys
2026
```
2127

2228
## Configuration
23-
### The configuration file is located at $HOME/.config/cleansys/config.json
29+
The configuration file is located at $HOME/.config/cleansys/config.json

0 commit comments

Comments
 (0)