Skip to content

Commit 1d9d5d9

Browse files
committed
📄 Add and update README.md in multiple folders
This commit added `README.md` to the project root and the Bluestacks folders. It also updated the README file in theBrain folder. For the README file under the project root, it has been created with: 1. a brief introduction to the project and its purpose; 2. a list of features with bullet points and bold text for the application names; 3. a usage section with instructions on how to run the scripts; 4. a contributing section with a link to the CONTRIBUTING.md file; 5. a license section with a link to the LICENSE file that contains the terms of GNU GPLv3 License. These changes are intended to make the README file more informative and user-friendly, and to highlight the main aspects and values of the project.
1 parent dbca8b6 commit 1d9d5d9

File tree

3 files changed

+47
-1
lines changed

3 files changed

+47
-1
lines changed

Bluestacks/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Optimize-BluestacksVEthernet.ps1
2+
3+
This script optimizes the network settings of Bluestacks Virtual Ethernet Adapter.
4+
5+
## Usage
6+
7+
1. Open PowerShell as an administrator.
8+
2. Navigate to the directory where the script is located.
9+
3. Run the following command:
10+
11+
```powershell
12+
.\Optimize-BluestacksVEthernet.ps1
13+
```
14+
15+
## License
16+
17+
The project is licensed under the GPLv3 License. See the [License](/LICENSE) file for details.

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# My PowerShell Scripts
2+
3+
This project provides a collection of PowerShell scripts that students may find useful or life hacking for various applications and tasks.
4+
5+
## Features
6+
7+
Some of the features of the project are:
8+
9+
- **OneNote**: You can use scripts to automate the creation, editing, and organization of notes, notebooks, and sections in OneNote.
10+
- **TheBrain**: You can use scripts to interact with theBrain, a powerful software for mind mapping and knowledge management.
11+
- **Windows**: You can use scripts to customize windows settings, create shortcuts, manage updates, and more.
12+
- **Bluestacks**: You can use scripts to perform tasks and actions in Bluestacks, an emulator that lets you run Android apps on PC.
13+
- **And more**: You can use scripts for other purposes, such as web scraping, file management, text processing, etc.
14+
15+
## Usage
16+
17+
To use the scripts in this project, you need to have PowerShell 5.1 or later installed on your computer. The programs that you wish to use, like OneNote, theBrain, Bluestacks, etc., must also be installed on your PC.
18+
19+
To run a script or function, you can either open PowerShell and type the name of the script or function, or you can right-click on the script file and select “Run with PowerShell”. You may need to change the execution policy of PowerShell to allow running scripts from external sources. You can do this by typing `Set-ExecutionPolicy RemoteSigned` in PowerShell.
20+
21+
For more details on how to utilize the scripts for a particular application, you can review the README files in the relevant folder.
22+
23+
## Contributing
24+
25+
The project is open-source and welcomes contributions from anyone who is interested in improving the productivity of learning activities with PowerShell. For more details on how to contribute to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file located in the project root directory.
26+
27+
## License
28+
29+
The project is licensed under the GPLv3 License. See the [License](/LICENSE) file for details.

theBrain/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ This project wouldn't be possible without the hard work and dedication of the co
7373

7474
## License
7575

76-
This project is licensed under the [GNU GPLv3](LICENSE) License.
76+
The project is licensed under the GPLv3 License. See the [License](/LICENSE) file for details.

0 commit comments

Comments
 (0)