Skip to content

Commit

Permalink
Cleaned READMEs for better readability & renamed all READMEs to UPPER…
Browse files Browse the repository at this point in the history
…CASE (#400)
  • Loading branch information
bernasiakk authored Jan 27, 2025
1 parent 03b3f6d commit 5e4c7b5
Show file tree
Hide file tree
Showing 9 changed files with 8 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Arrange It/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ With the help of this script, files can be moved automatically to the folder tha

## New Feature: Custom Folder Configuration

-Now, you can customize how files are arranged by defining your own folder structure and file extensions using a config.json file. This allows for more flexibility without needing to modify the Python code itself.
Now, you can customize how files are arranged by defining your own folder structure and file extensions using a config.json file. This allows for more flexibility without needing to modify the Python code itself.
`python arrangeit.py`

# How To Use the config.json File
Expand Down
6 changes: 3 additions & 3 deletions AutoCert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ A Python script to auto generate e-certificates in bulk.

# Instruction to use
<ol>
<li>First install all the dependencies, present in the requirements.txt file </li>
<li>Put a certificate template with blank fields, in the project folder, with the name `certificateTemplate.png` .Make sure the template is in `png` format only</li>
<li>First install all the dependencies, present in the requirements.txt file.</li>
<li>Put a certificate template with blank fields, in the project folder, with the name `certificateTemplate.png`. Make sure the template is in `png` format only.</li>
<li>Put the input `csv` file containing a list of the participant names by under a column name. </li>
<li>Once all this is done, run `python3 main.py` in your terminal</li>
<li>Once all this is done, run `python3 main.py` in your terminal.</li>
<li>The generated certificates would be present under the *export* folder, with each certificate having the name of the participant.</li>
</ol>

Expand Down
3 changes: 1 addition & 2 deletions Black Hat Python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Simply choose a directory (DIR) in which to clone the project using
git clone https://github.com/DhanushNehru/Python-Scripts/Black Hat Python.git
```

create a new virtual environment or `venv` for it (recommended
) and install the requirements using `pip install`.
create a new virtual environment or `venv` for it (recommended) and install the requirements using `pip install`.


<!-- Updated README links and corrected typos -->
Expand Down
2 changes: 1 addition & 1 deletion Cafe Management System/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cafe Management System

- This is a cafe Management System Coded by Python using `tkinter` library.
- You need to install `Pillow`by entering `pip install Pillow`.
- You need to install `Pillow` by entering `pip install Pillow`.
<!-- Updated README links and corrected typos -->
<!-- Updated README links and corrected typos -->
2 changes: 1 addition & 1 deletion Chess Board/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This repository consists of a list of python scripts to automate few tasks.
This repository consists of a list of python scripts to automate a few tasks.

You can contribute by adding more python scripts which can be used to automate things. Some of already done are listed below.
Incase you have anything to be followed while executing the python script mention it as well
Expand Down
2 changes: 1 addition & 1 deletion Expense Tracker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Install the required dependencies using pip:
```
pip install -r requirements.txt
```
or you can manually install single Library
or you can manually install single Library.

Run the expense.py file to start the bot:

Expand Down
3 changes: 0 additions & 3 deletions Password Strength Checker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,13 @@ A password strength checker that utilizes machine learning to classify the stren
```bash
git clone https://github.com/DhanushNehru/Python-Scripts
cd "Password Strength Checker"

2. Create and activate a virtual environment:
```bash
python3 -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
3. Install the required packages:
```bash
pip install -r requirements.txt

## Usage
To run the password strength checker:
```bash
Expand Down
File renamed without changes.
3 changes: 0 additions & 3 deletions import of music and video/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Before you begin, ensure you have met the following requirements:

```bash
pip install pygame


## Usage
Clone or download this repository to your local machine.
Open your terminal or command prompt and navigate to the project directory.
Expand Down Expand Up @@ -50,7 +48,6 @@ Before you begin, ensure you have met the following requirements:
```bash
pip install opencv-python
**Usage**
Clone or download this repository to your local machine.
Open your terminal or command prompt and navigate to the project directory.
Expand Down

0 comments on commit 5e4c7b5

Please sign in to comment.