josharsh / josharsh/OPython-Init

Change md file names to README.md in each lesson subdirectory

Open
#111 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
165
Forks
196
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
When you navigate the lessons, the user clicks on the directory (i.e., Course Introduction), and is shown the contents of the directory. The user then must know to click on the markdown file to see the information.

**Describe the solution you'd like**
A simple change that would make the repo easier to use is to rename the markdown files in each lesson subdirectory to README.md. If you do that, when you click on the directory, the markdown will auomatically show, without having to select it.

**Describe alternatives you've considered**
It is fine as it is - most users will know what to do, but this change is simple and may make the repo easier to use.

**Additional context**
Just comment if you would like for me to make this change and I'll raise a PR.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.