Skip to content

Commit 2e319b2

Browse files
author
FriedrichWeinmann
committed
Updating description
And some finetuning
1 parent 1f3e98f commit 2e319b2

3 files changed

Lines changed: 39 additions & 2 deletions

File tree

‎.gitignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
*TempPoint*
2+
*.pssproj
3+
4+
# ignore the settings folder and files for VSCode
5+
.vscode/*
6+
*.psproj
7+
8+
# ignore library
9+
PSModuleDevelopment/bin/PSModuleDevelopment.dll
10+
PSModuleDevelopment/bin/PSModuleDevelopment.xml
11+
PSModuleDevelopment/bin/PSModuleDevelopment.pdb

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2017 FriedrichWeinmann
3+
Copyright (c) 2017 Friedrich Weinmann
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
# PSModuleDevelopment
1+
# Purpose
2+
3+
The PSModuleDevelopment module is designed to provide tools that help with - big surprise incoming - module development.
4+
This attempts to help with:
5+
- Speeding up iterative procedures, especially reinitiating tests runs
6+
- Debugging Execution
7+
- Development Research & Analytics
8+
- Miscellaneous other things
9+
10+
# Alias Warning
11+
12+
This module actually ships with convenience aliases.
13+
14+
Generally, modules should leave aliases like that to the user's preference.
15+
However, in this instance, the main purpose is to optimize the performance of the developer, which requires the use of aliases.
16+
17+
Due to this, the decision was made to ship the module with aliases.
18+
19+
# Configuration Notice
20+
21+
This module uses the PSFramework for configuration management (and many other things).
22+
Run `Get-PSFConfig -Module PSModuleDevelopment` in order to retrieve the full list of configurations set.
23+
24+
# Profile notice
25+
26+
Some features of this module assume, that it is in the profile and automtically imported on console start.
27+
It is still possible to profit from the module without this, but it is highly recommended to add the module import to the PowerShell profile

0 commit comments

Comments
 (0)