Skip to content

Commit 3b3de3b

Browse files
committed
docs: remove outdated sections from README files to streamline content
1 parent a7f4e47 commit 3b3de3b

2 files changed

Lines changed: 0 additions & 43 deletions

File tree

‎README.md‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ This is a template repository for python module projects.
99
## ✨ Features
1010

1111
- Python module/package
12-
- Project Structure
13-
- Boilerplate/Template
14-
- Best Practices
1512
- Configuration
1613
- Test
1714
- Build
@@ -20,25 +17,6 @@ This is a template repository for python module projects.
2017
- Examples
2118
- CI/CD
2219

23-
## 🧩 Template
24-
25-
- You can use this template repository as reference to create a new repository with the same structure or clone the repository to start a new project. It will help you to organize your project structure and files. It works out of the box for most of the python projects.
26-
- You can customize (remove, modify or add) the files and directories as needed to meet your project requirements.
27-
- If you want to use the template repository directly, just click the **[Use this template](https://github.com/new?template_name=module-python-template&template_owner=bybatkhuu)** button and follow the instructions.
28-
- You can use **cookiecutter** to generate a new project from **[cookiecutter](https://github.com/bybatkhuu/module-python-template/tree/cookiecutter)** branch:
29-
30-
```sh
31-
# Clone the cookiecutter branch:
32-
git clone -b cookiecutter https://github.com/bybatkhuu/module-python-template.git
33-
34-
# Install cookiecutter:
35-
pip install cookiecutter
36-
37-
# Generate a new project from the cookiecutter template:
38-
cookiecutter -f ./module-python-template
39-
40-
---
41-
4220
## 🛠 Installation
4321

4422
### 1. 🚧 Prerequisites

‎docs/README.md‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,10 @@ This is a template repository for python module projects.
1212
## ✨ Features
1313

1414
- Python module/package
15-
- Project Structure
16-
- Boilerplate/Template
17-
- Best Practices
1815
- Configuration
1916
- Test
2017
- Build
2118
- Documentation
2219
- Scripts
2320
- Examples
2421
- CI/CD
25-
26-
## 🧩 Template
27-
28-
- You can use this template repository as reference to create a new repository with the same structure or clone the repository to start a new project. It will help you to organize your project structure and files. It works out of the box for most of the python projects.
29-
- You can customize (remove, modify or add) the files and directories as needed to meet your project requirements.
30-
- If you want to use the template repository directly, just click the **[Use this template](https://github.com/new?template_name=module-python-template&template_owner=bybatkhuu)** button and follow the instructions.
31-
- You can use **cookiecutter** to generate a new project from **[cookiecutter](https://github.com/bybatkhuu/module-python-template/tree/cookiecutter)** branch:
32-
33-
```sh
34-
# Clone the cookiecutter branch:
35-
git clone -b cookiecutter https://github.com/bybatkhuu/module-python-template.git
36-
37-
# Install cookiecutter:
38-
pip install cookiecutter
39-
40-
# Generate a new project from the cookiecutter template:
41-
cookiecutter -f ./module-python-template
42-
```

0 commit comments

Comments
 (0)