mirrors/PowerShell
0
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell.git synced 2024-11-23 09:43:57 +08:00
Code Issues Packages Projects Releases Wiki Activity
e7e82ede96
PowerShell/README.md

140 lines
6.1 KiB
Markdown
Raw Normal View History

Rewrite README
2016-07-28 05:47:03 +08:00
![logo][] PowerShell
====================
Add a readme
2015-07-02 06:06:29 +08:00
Fix typo in readme
2016-08-18 23:55:00 +08:00
Welcome to the PowerShell GitHub Community!
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
PowerShell is a cross-platform (Windows, Linux, and macOS) automation and configuration tool/framework that works well with your existing tools and is optimized for dealing with structured data (e.g. JSON, CSV, XML, etc.), REST APIs, and object models.
It includes a command-line shell, an associated scripting language and a framework for processing cmdlets.
Updated description of PowerShell (#1848) * Updated description of PowerShell * fixed one line per sentence (per protocol)
2016-08-18 01:29:14 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
[logo]: assets/Powershell_64.png
Add build instructions matrix to readme
2016-03-31 06:13:29 +08:00
Updated per feedback.
2016-06-25 02:18:01 +08:00
New to PowerShell?
------------------
Add build instructions matrix to readme
2016-03-31 06:13:29 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
If you are new to PowerShell and would like to learn more, we recommend reviewing the [getting started][] documentation.
Add AppVeyor CI integration. AppVeyor is a cloud-based CI platform for windows. Use [skip ci] tag in any place of message to mark commit as trivial (i.e. README.md changes).
2016-01-23 03:36:23 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
[getting started]: docs/learning-powershell
Refactor readme header
2016-03-31 03:06:57 +08:00
Add build instructions matrix to readme
2016-03-31 06:13:29 +08:00
Get PowerShell
--------------
Rewrite README
2016-07-28 05:47:03 +08:00
You can download and install a PowerShell package for any of the following platforms.
Create a PowerShell Docker image.
2016-08-20 03:37:28 +08:00
| Platform | Downloads | How to Install |
| ------------------------------ | ---------------------- | ----------------------------- |
| Windows 10 / Server 2016 | [.msi][rl-windows10] | [Instructions][in-windows] |
| Windows 8.1 / Server 2012 R2 | [.msi][rl-windows81] | [Instructions][in-windows] |
| Ubuntu 16.04 | [.deb][rl-ubuntu16] | [Instructions][in-ubuntu16] |
| Ubuntu 14.04 | [.deb][rl-ubuntu14] | [Instructions][in-ubuntu14] |
| CentOS 7 | [.rpm][rl-centos] | [Instructions][in-centos] |
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
| OS X 10.11 | [.pkg][rl-macos] | [Instructions][in-macos] |
Create a PowerShell Docker image.
2016-08-20 03:37:28 +08:00
| Docker | | [Instructions] [in-docker] |
Update links for alpha.9 Also adds the Windows 8.1 build to the readme, and bumps the AppVeyor build number.
2016-08-16 10:02:27 +08:00
[rl-windows10]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.9/PowerShell_6.0.0.9-alpha.9-win10-x64.msi
[rl-windows81]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.9/PowerShell_6.0.0.9-alpha.9-win81-x64.msi
Fix naming of Unix packages - .NET Core RID suffixes removed - `el7.centos` suffix added to RPM - `1ubuntu1.14.04.1` iteration used for DEB packages `~` cannot be used after `ubuntu1` because GitHub release renames it to a `.`; additionally, no packages lack the final suffix `.1`. While my machine is `.5` I could find no packages that went past `.3`, so let's use this to indicate that it works for `14.04.1` and forward. We are *not* recreating the alpha.9 packages, but will we rename them accordingly. This means that the filenames will be "correct" but the meta-data will be out-of-date.
2016-08-17 05:15:05 +08:00
[rl-ubuntu16]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.9/powershell_6.0.0-alpha.9-1ubuntu1.16.04.1_amd64.deb
[rl-ubuntu14]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.9/powershell_6.0.0-alpha.9-1ubuntu1.14.04.1_amd64.deb
[rl-centos]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.9/powershell-6.0.0_alpha.9-1.el7.centos.x86_64.rpm
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
[rl-macOS]: https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.9/powershell-6.0.0-alpha.9.pkg
Rewrite README
2016-07-28 05:47:03 +08:00
[installation]: docs/installation
[in-windows]: docs/installation/windows.md#msi
Update releases on readme
2016-08-12 07:55:04 +08:00
[in-ubuntu14]: docs/installation/linux.md#ubuntu-1404
[in-ubuntu16]: docs/installation/linux.md#ubuntu-1604
Rewrite README
2016-07-28 05:47:03 +08:00
[in-centos]: docs/installation/linux.md#centos-7
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
[in-macos]: docs/installation/linux.md#macos-1011
Create a PowerShell Docker image.
2016-08-20 03:37:28 +08:00
[in-docker]: docs/installation/docker.md
Updated per feedback.
2016-06-25 02:18:01 +08:00
Update README.md
2016-08-06 05:10:42 +08:00
To install a specific version, visit [releases](https://github.com/PowerShell/PowerShell/releases).
update some wording
2016-07-14 06:59:08 +08:00
Add Gitter chat room badge
2016-08-18 23:44:07 +08:00
Chat Room
---------
Want to chat with other members of the PowerShell community?
[![Join the chat at https://gitter.im/PowerShell/PowerShell](https://badges.gitter.im/PowerShell/PowerShell.svg)](https://gitter.im/PowerShell/PowerShell?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Rewrite README
2016-07-28 05:47:03 +08:00
Building the Repository
-----------------------
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
| Linux | Windows | macOS |
Rewrite README
2016-07-28 05:47:03 +08:00
|--------------------------|----------------------------|------------------------|
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
| [Instructions][bd-linux] | [Instructions][bd-windows] | [Instructions][bd-macOS] |
Rewrite README
2016-07-28 05:47:03 +08:00
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
If you have any problems building, please consult the developer [FAQ][].
### Build status of master branches
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
| AppVeyor (Windows) | Travis CI (Linux / macOS) |
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
|--------------------------|--------------------------|
| [![av-image][]][av-site] | [![tv-image][]][tv-site] |
Rewrite README
2016-07-28 05:47:03 +08:00
[bd-linux]: docs/building/linux.md
[bd-windows]: docs/building/windows-core.md
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
[bd-macOS]: docs/building/macos.md
Add explicit dependency instructions to README
2016-01-22 04:25:48 +08:00
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
[FAQ]: docs/FAQ.md
Fix CI badges
2016-08-18 23:24:26 +08:00
[tv-image]: https://travis-ci.org/PowerShell/PowerShell.svg?branch=master
[tv-site]: https://travis-ci.org/PowerShell/PowerShell/branches
Fix AppVeyor badge image
2016-08-18 23:26:11 +08:00
[av-image]: https://ci.appveyor.com/api/projects/status/nsng9iobwa895f98/branch/master?svg=true
Fix CI badges
2016-08-18 23:24:26 +08:00
[av-site]: https://ci.appveyor.com/project/PowerShell/powershell
Move build badges * Remove superfluous link to releases page * Remove superfluous link to docs/build * Add column back for install instructions * Add extra link to the FAQ
2016-07-29 03:45:31 +08:00
added "recursive cloning" back to readme per request #1197
2016-07-21 08:09:41 +08:00
Downloading the Source Code
Rewrite README
2016-07-28 05:47:03 +08:00
---------------------------
added "recursive cloning" back to readme per request #1197
2016-07-21 08:09:41 +08:00
The PowerShell repository has a number of other repositories embedded as submodules.
Rewrite README
2016-07-28 05:47:03 +08:00
Use pronounces consistently in cloning instruction
2016-08-11 13:52:53 +08:00
To make things easy, you can just clone recursively:
added "recursive cloning" back to readme per request #1197
2016-07-21 08:09:41 +08:00
```sh
git clone --recursive https://github.com/PowerShell/PowerShell.git
```
Updated the Downloading Source code section to address the feedback from lzybkr.
2016-07-21 08:23:06 +08:00
If you already cloned but forgot to use `--recursive`, you can update submodules manually:
Rewrite README
2016-07-28 05:47:03 +08:00
Updated the Downloading Source code section to address the feedback from lzybkr.
2016-07-21 08:23:06 +08:00
```sh
Rewrite README
2016-07-28 05:47:03 +08:00
git submodule update --init
Updated the Downloading Source code section to address the feedback from lzybkr.
2016-07-21 08:23:06 +08:00
```
Rewrite README
2016-07-28 05:47:03 +08:00
Make 101.md the tree's README.md
2016-07-28 05:51:18 +08:00
See [working with the PowerShell repository](docs/git) for more information.
Rewrite README
2016-07-28 05:47:03 +08:00
Drafted update to contribution guidelines
2016-07-20 06:18:10 +08:00
Developing and Contributing
--------------------------
Simplified over complicated table into single link. Removed redundant contributing text and replaced with link to contributing doc. Removed maitaner specific text and replaced with link to contributor specific section for the topic
2016-07-21 02:18:28 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
Please see the [Contribution Guide][] for how to develop and contribute.
Update Git setup documentation Now that everyone needs all the submodules. Much simpler.
2016-04-13 07:16:17 +08:00
Rewrite README
2016-07-28 05:47:03 +08:00
If you have any problems, please consult the [known issues][], developer [FAQ][], and [GitHub issues][].
If you do not see your problem captured, please file a [new issue][] and follow the provided template.
OS X -> macOS (#1934) Fix all documentation references of "OS X" to be "macOS", Apple's new brand. Code is left unchanged because we're matching .NET Core.
2016-08-27 03:08:50 +08:00
If you are developing .NET Core C# applications targeting PowerShell Core, please [check out our FAQ][] to learn more about the PowerShell SDK NuGet package.
(WIP) Updated draft of readme for PM review.
2016-06-23 23:21:07 +08:00
add information about the powershell sdk package in readme.md (#1896)
2016-08-19 04:34:59 +08:00
[check out our FAQ]: docs/FAQ.md#where-do-i-get-the-powershell-core-sdk-package
Rewrite README
2016-07-28 05:47:03 +08:00
[Contribution Guide]: .github/CONTRIBUTING.md
[known issues]: docs/KNOWNISSUES.md
[GitHub issues]: https://github.com/PowerShell/PowerShell/issues
[new issue]:https://github.com/PowerShell/PowerShell/issues/new
Add official Microsoft Open Source Code of Conduct
2016-06-25 01:47:46 +08:00
update README with license info
2016-07-30 05:10:26 +08:00
Legal and Licensing
-------------------
PowerShell is licensed under the [MIT license][].
[MIT license]: LICENSE.txt
Add reference to governance document on to readme
2016-08-13 04:27:04 +08:00
Governance
-------------------
Governance policy for PowerShell project is described [here][].
[here]: https://github.com/PowerShell/PowerShell/blob/master/docs/community/governance.md
Add official Microsoft Open Source Code of Conduct
2016-06-25 01:47:46 +08:00
Code of Conduct
---------------
added "recursive cloning" back to readme per request #1197
2016-07-21 08:09:41 +08:00
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
Rewrite README
2016-07-28 05:47:03 +08:00
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.
Add official Microsoft Open Source Code of Conduct
2016-06-25 01:47:46 +08:00
[conduct-code]: http://opensource.microsoft.com/codeofconduct/
Addressed @jianyun `s and @vor 's PR comments
2016-07-20 06:18:55 +08:00
[conduct-FAQ]: http://opensource.microsoft.com/codeofconduct/faq/
Rewrite README
2016-07-28 05:47:03 +08:00
[conduct-email]: mailto:opencode@microsoft.com
Reference in New Issue Copy Permalink