Skip to content

Commit 32f7739

Browse files
committed
docs: streamline installation instructions by removing download/clone steps
1 parent ab99b41 commit 32f7739

File tree

2 files changed

+5
-72
lines changed

2 files changed

+5
-72
lines changed

README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -40,42 +40,7 @@ It is a `Loguru` based custom logging package for python projects.
4040
- Install [**git**](https://git-scm.com/downloads)
4141
- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
4242

43-
### 2. 📥 Download or clone the repository
44-
45-
[TIP] Skip this step, if you're going to install the package directly from **PyPi** or **GitHub** repository.
46-
47-
**2.1.** Prepare projects directory (if not exists):
48-
49-
```sh
50-
# Create projects directory:
51-
mkdir -pv ~/workspaces/projects
52-
53-
# Enter into projects directory:
54-
cd ~/workspaces/projects
55-
```
56-
57-
**2.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
58-
59-
**OPTION A.** Clone the repository:
60-
61-
```sh
62-
git clone https://github.com/bybatkhuu/module-python-logging.git && \
63-
cd module-python-logging
64-
```
65-
66-
**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
67-
68-
```sh
69-
git clone [email protected]:bybatkhuu/module-python-logging.git && \
70-
cd module-python-logging
71-
```
72-
73-
**OPTION C.** Download source code:
74-
75-
1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/module-python-logging/releases).
76-
2. Extract it into the projects directory.
77-
78-
### 3. 📦 Install the package
43+
### 2. 📦 Install the package
7944

8045
[NOTE] Choose one of the following methods to install the package **[A ~ F]**:
8146

@@ -94,6 +59,9 @@ pip install git+https://github.com/bybatkhuu/module-python-logging.git
9459
**OPTION C.** Install from the downloaded **source code**:
9560

9661
```sh
62+
git clone https://github.com/bybatkhuu/module-python-logging.git && \
63+
cd ./module-python-logging
64+
9765
# Install directly from the source code:
9866
pip install .
9967

docs/getting-started/installation.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,7 @@ title: Installation
44

55
# 🛠 Installation
66

7-
## 1. 📥 Download or clone the repository
8-
9-
[TIP] Skip this step, if you're going to install the package directly from **PyPi** or **GitHub** repository.
10-
11-
**1.1.** Prepare projects directory (if not exists):
12-
13-
```sh
14-
# Create projects directory:
15-
mkdir -pv ~/workspaces/projects
16-
17-
# Enter into projects directory:
18-
cd ~/workspaces/projects
19-
```
20-
21-
**1.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
22-
23-
**OPTION A.** Clone the repository:
24-
25-
```sh
26-
git clone https://github.com/bybatkhuu/module-python-logging.git && \
27-
cd module-python-logging
28-
```
29-
30-
**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
31-
32-
```sh
33-
git clone [email protected]:bybatkhuu/module-python-logging.git && \
34-
cd module-python-logging
35-
```
36-
37-
**OPTION C.** Download source code:
38-
39-
1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/module-python-logging/releases).
40-
2. Extract it into the projects directory.
41-
42-
### 2. 📦 Install the package
7+
## 📦 Install the package
438

449
[NOTE] Choose one of the following methods to install the package **[A ~ F]**:
4510

0 commit comments

Comments
 (0)