Light Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit e7c70ec

Browse files
authored
Merge pull request #21 from chriskyfung:docs/update-project-documentation-and-config
docs: update project documentation and config
2 parents 80a4542 + 7f04790 commit e7c70ec

File tree

4 files changed

+47
-4
lines changed
  • .vscode
    • settings.json
  • CODE_OF_CONDUCT.md
  • PSScriptAnalyzerSettings.desktop-3.0-windows.psd1
  • README.md

4 files changed

+47
-4
lines changed

.vscode/settings.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
{
2+
"files.exclude": {
3+
"**/.git": true,
4+
"**/.svn": true,
5+
"**/.hg": true,
6+
"**/CVS": true,
7+
"**/.DS_Store": true,
8+
"**/Thumbs.db": true,
9+
"./Bluestakcs": false
10+
},
211
"powershell.codeFormatting.avoidSemicolonsAsLineTerminators": true
312
}

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ representative at an online or offline event.
5959
## Enforcement
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
.
62+
reported to the community leaders responsible for enforcement at [GitHub Discusssions](https://github.com/chriskyfung/My-PowerShell-Scripts/discussions).
6463
All complaints will be reviewed and investigated promptly and fairly.
6564

6665
All community leaders are obligated to respect the privacy and security of the

PSScriptAnalyzerSettings.desktop-3.0-windows.psd1

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
'5.1'
1515
'4.0'
1616
'3.0'
17-
'2.0'
1817
)
1918
}
2019
}

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,50 @@ Some of the features of the project are:
1212
- **Bluestacks**: You can use scripts to perform tasks and actions in Bluestacks, an emulator that lets you run Android apps on PC.
1313
- **And more**: You can use scripts for other purposes, such as web scraping, file management, text processing, etc.
1414

15+
## Requirements
16+
17+
To run these scripts, you need:
18+
19+
- PowerShell 5.1 or higher
20+
- Microsoft Onenote 2016 or higher
21+
- TheBrain 13 or higher
22+
- Some third-party PowerShell modules (see the scripts for details)
23+
1524
## Usage
1625

1726
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.
1827

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.
28+
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".
29+
30+
**Basic Steps**
31+
1. Clone or download this repository to your computer
32+
2. Open PowerShell and change the current directory to the repository folder
33+
3. Run the scripts with the appropriate parameters (see the scripts for details)
34+
4. Enjoy!
35+
36+
**NOTE**
37+
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.
2038

2139
For more details on how to utilize the scripts for a particular application, you can review the README files in the relevant folder.
2240

41+
## Disclaimer
42+
43+
These scripts are provided as-is, without any warranty or support. Use them at your own risk. I am not responsible for any damage or data loss that may occur from using these scripts. Always backup your data before running any script.
44+
45+
## You may also like
46+
47+
[fleschutz/PowerShell](https://github.com/fleschutz/PowerShell) - Mega collection of 500+ useful cross-platform PowerShell scripts (.ps1)
48+
49+
[brianary/scripts](https://github.com/brianary/scripts) - General-purpose PowerShell, F, and other scripts
50+
51+
[microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) - Microsoft PowerShell wrapper for GitHub API
52+
53+
[PoshlandPro/PSNotion](https://github.com/PoshlandPro/PSNotion/) - A Powershell Module for Notion
54+
55+
[dfinke/ImportExcel](https://github.com/dfinke/ImportExcel) - A PowerShell module to importexport Excel spreadsheets, without Excel
56+
57+
[pcgeek86/youtube](https://github.com/pcgeek86/youtube/) - A PowerShell module to manage YouTube content via the official REST API.
58+
2359
## Contributing
2460

2561
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.

0 commit comments

Comments
(0)