-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.template
139 lines (92 loc) · 4.18 KB
/
README.md.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<div align="center">
# Folder Mapping
[](https://github.com/RomanFama592/folder_mapping_action/actions/workflows/pylint.yml)
[](https://github.com/RomanFama592/folder_mapping_action/actions/workflows/update_readme.yml)
</div>
This project is a **CLI tool** that maps the folder structure of a directory and generates an output file with a customizable name based on a template. The main purpose of this tool is to provide a clear and concise representation of the folder structure, taking into account exclusions defined in the `.gitignore` file to avoid displaying specific files. Skip the files until you find another `.gitignore` file. From that path onwards, exclude the files specified in this new file.
<details>
<summary>📑 <strong>Contents</strong></summary>
<ol>
<li><a href="#project-structure">🚀 <strong>Project Structure</strong></a></li>
<li><a href="#usage">✨ <strong>Usage</strong></a></li>
<li><a href="#contributions">👋 <strong>Contributions</strong></a></li>
<li><a href="#license">👨⚖️ <strong>License</strong></a></li>
<li><a href="#contact-me">📬 <strong>Contact me</strong></a></li>
</ol>
</details>
<br>
<p align="right"><a href="#top">Back to top 🔼</a></p>
<br>
## 🚀 Project Structure
Folder map and example of use:
```
%{{map_folder}}%
```
<p align="right"><a href="#top">Back to top 🔼</a></p>
<br>
## ✨ Usage
- **Example of using workflow in [README.md.template](https://github.com/RomanFama592/folder_mapping_action/blob/main/README.md.template)**
- **Example of using template in [update_readme.yml](https://github.com/RomanFama592/folder_mapping_action/blob/main/.github/workflows/update_readme.yml)**
```yaml
- uses: RomanFama592/folder_mapping_action@v1
with:
path-directory:
description: "Path to the directory for folder mapping."
default: "./"
template-output:
description: "Path to the template file for README.md generation."
default: "./README.md.template"
path-output:
description: "Path where the generated README.md file will be saved."
default: "./README.md"
search-word:
description: "Keyword or search term in the template file for folder mapping."
default: "map_folder"
```
_In your template put `%{{` + your **search word** + `}}%` to find where you want to put the map folder._
<p align="right"><a href="#top">Back to top 🔼</a></p>
<br>
## 👋 Contributions
Contributions are what make the Open Source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a Pull Request. You can also simply [open an issue](https://github.com/RomanFama592/folder_mapping_action/issues)
Don't forget to **give the project a star ⭐!** Thanks again!
1. Fork the project
2. Clone your fork
```bash
git clone https://github.com/@your_username/folder_mapping_action
```
3. Install `pipenv`
```bash
pip install pipenv
```
4. Install dependencies
```bash
pipenv install --dev
```
5. Open enviroment of Python
```bash
pipenv shell
```
6. Create your Feature Branch
```bash
git checkout -b feature/AmazingFeature
```
7. Push to the Branch
```bash
git push origin feature/AmazingFeature
```
8. Open a Pull Request
**Important**: Use "conventional commits" and ensure that the code passes the linter test, pull requests are not accepted without this last point.
<p align="right"><a href="#top">Back to top 🔼</a></p>
<br>
## 👨⚖️ License
Distributed under the MIT License. See `LICENSE` for more information.
<p align="right"><a href="#top">Back to top 🔼</a></p>
<br>
## 📬 Contact me
**Famá Román**
- [Linkedin](https://www.linkedin.com/in/romanfama)
<p align="right"><a href="#top">Back to top 🔼</a></p>