8000 Create README.md · TheAlgorithms/scripts@7366758 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7366758

Browse files
authored
Create README.md
1 parent 8983c1a commit 7366758

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# The Algorithms Scripts
2+
3+
Internal scripts used across all The Algorithms repositories
4+
5+
## build_directory_md.py
6+
This script should be run by a workflow on every push and pr to update the `DIRECTORY.md` file. It takes the following arguments:
7+
```
8+
[0] - Language
9+
[1] - Base path
10+
[2] - Allowed filenames
11+
[3] - Files or folders to ignore (optional)
12+
[4] - Folders to ignore, but include children (optional)
13+
```
14+
For example, the command for the C++ repo would be:
15+
```bash
16+
python3 build_directory_md.py C-Plus-Plus . .cpp,.hpp,.h > DIRECTORY.md
17+
```
18+
Or more advanced, for the MATLAB / Octave repo:
19+
```bash
20+
python3 build_directory_md.py MATLAB-Octave . .m - algorithms > DIRECTORY.md

0 commit comments

Comments
 (0)
0