updating readme
This commit is contained in:
Родитель
8ab635e77a
Коммит
6f6421b37b
|
|
@ -1,47 +1,47 @@
|
|||
Contributing to Windows Dev Box Setup Scripts
|
||||
|
||||
The goal for **Windows Dev Box Setup Scripts** is to help developers get their dev box up and going quickly.
|
||||
|
||||
## Before you begin
|
||||
|
||||
We're grateful for any and all contributions. Before you submit a PR we ask that you consider the following points.
|
||||
|
||||
* Please create or comment on an existing issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it also enables the community to discuss the particulars with you. It's less work for everyone, in the long run, to establish this up front.
|
||||
* When adding to a setup script, the addition should be useful to the majority of developers working with the dev stack the script is intended for.
|
||||
|
||||
|
||||
## A good pull request
|
||||
|
||||
Every contribution has to come with:
|
||||
|
||||
* Before making the change, **please open an issue** or comment on an existing issue, and start discussing with the community to see if the idea/feature is interesting enough.
|
||||
|
||||
* For both new scripts and script changes please test the entire script on Windows 10.
|
||||
|
||||
The core team will test the change to validate it before merging it.
|
||||
|
||||
|
||||
## Repository Structure
|
||||
|
||||
Scripts are named with dev_[MAJOR_AREA]_[MINORAREA].
|
||||
The Minor Area is optional. Currently the scripts are completely self contained - there is no script chaining. It would be useful to move to a tree model, and we'll update these instructions if/when that happens.
|
||||
|
||||
Examples
|
||||
- dev_web_nodejs
|
||||
- dev_app_android
|
||||
- dev_ml
|
||||
|
||||
Current Major Areas
|
||||
- web
|
||||
- app
|
||||
- ml (machine learning)
|
||||
- iot
|
||||
- backend
|
||||
|
||||
Minor Area is open
|
||||
|
||||
If you have a change request for Major Area please let us know by filing an issue.
|
||||
|
||||
If the script has additional steps please create a folder for your script and include a Readme with these instructions.
|
||||
|
||||
Contributing to Windows Dev Box Setup Scripts
|
||||
|
||||
The goal for **Windows Dev Box Setup Scripts** is to help developers get their dev box up and going quickly.
|
||||
|
||||
## Before you begin
|
||||
|
||||
We're grateful for any and all contributions. Before you submit a PR we ask that you consider the following points.
|
||||
|
||||
* Please create or comment on an existing issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it also enables the community to discuss the particulars with you. It's less work for everyone, in the long run, to establish this up front.
|
||||
* When adding to a setup script, the addition should be useful to the majority of developers working with the dev stack the script is intended for.
|
||||
|
||||
|
||||
## A good pull request
|
||||
|
||||
Every contribution has to come with:
|
||||
|
||||
* Before making the change, **please open an issue** or comment on an existing issue, and start discussing with the community to see if the idea/feature is interesting enough.
|
||||
|
||||
* For both new scripts and script changes please test the entire script on Windows 10.
|
||||
|
||||
The core team will test the change to validate it before merging it.
|
||||
|
||||
|
||||
## Repository Structure
|
||||
|
||||
Scripts are named with dev_[MAJOR_AREA]_[MINORAREA].
|
||||
The Minor Area is optional. Currently the scripts are completely self contained - there is no script chaining. It would be useful to move to a tree model, and we'll update these instructions if/when that happens.
|
||||
|
||||
Examples
|
||||
- dev_web_nodejs
|
||||
- dev_app_android
|
||||
- dev_ml
|
||||
|
||||
Current Major Areas
|
||||
- web
|
||||
- app
|
||||
- ml (machine learning)
|
||||
- iot
|
||||
- backend
|
||||
|
||||
Minor Area is open
|
||||
|
||||
If you have a change request for Major Area please let us know by filing an issue.
|
||||
|
||||
If the script has additional steps please create a folder for your script and include a Readme with these instructions.
|
||||
|
||||
Thank you!
|
||||
99
README.md
99
README.md
|
|
@ -1,51 +1,48 @@
|
|||
|
||||
# About this project
|
||||
The goal of this project is to provide a central place to share ideas for streamlining dev box setup and provide sample scripts for common dev scenarios. It's likely you will want to take the scripts here and modify them to fit your particular needs. When you make those changes if you think others would benefit please consider submitting a PR. Before you contribute please see the [Contribution Guidelines](CONTRIBUTING.md).
|
||||
|
||||
These scripts leverage two popular open source projects.
|
||||
- Boxstarter [boxstarter.org](http://boxstarter.org)
|
||||
|
||||
|
||||
|
||||
- Chocolatey [chocolatey.org](http://chocolatey.org)
|
||||
|
||||
## How to run the scripts
|
||||
Before you begin, please read the [Legal](#Legal) section.
|
||||
|
||||
To run a script click a link in the table below. This will download Boxstarter, and prompt you for Boxstarter to run with Administrator privileges (which it needs to do its job). Clicking yes in this dialog will cause the script to begin. You can then leave the job unattended and come back when it's finished.
|
||||
|
||||
|Link |Description |
|
||||
|---------|---------|
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_app.ps1?token=AK0OHpRu7iHVJgnn7DsbBumVp2C4ljleks5a9LuJwA%3D%3D'>Desktop App</a> | Windows Desktop App Development (Visual Studio, Windows SDK) |
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_web.ps1?token=AK0OHhoec2cUUr7i0KVnUReiLhzNPGxXks5a9LugwA%3D%3D'>Web</a> | Web (VS Code, Multiple Browsers) |
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_web_nodejs.ps1?token=AK0OHg--lXI4lmyAFY_wN2CKxWnUaaSRks5a8VJjwA%3D%3D'>Web NodeJS</a> | Web Dev with NodeJS (Web + NodeJS LTS) |
|
||||
| | Xamarin (Visual Studio, Xamarin, Android SDK) |
|
||||
| | Machine Learning |
|
||||
| | Containers (Kubernetes, etc...) |
|
||||
| | More Coming Soon! |
|
||||
|
||||
## Working with Chocolatey for Organizations?
|
||||
No problem, you can still use these scripts. You'll need to modify the script to reference your internal package store. Here are instructions for doing so:
|
||||
|
||||
[ADD INSTRUCTIONS]
|
||||
|
||||
## Setting up a VM
|
||||
Windows 10 VM setup instructions
|
||||
1. Use Quick Create to set up a VM
|
||||
2. Once signed in to your VM, browse to this project and click a script link in the table of scripts
|
||||
|
||||
# Legal
|
||||
Please read before using scripts.
|
||||
|
||||
#### Using our scripts downloads third party software
|
||||
When you use our sample scripts, these will direct to Chocolately to install the packages.
|
||||
By using Chocolatey to install a package, you are accepting the license for the application, executable(s), or other artifacts delivered to your machine as a result of a Chocolatey install. This acceptance occurs whether you know the license terms or not. Read and understand the license terms of any package you plan to install prior to installation through Chocolatey. If you do not want to accept the license of a package you are installing, you need to uninstall the package and any artifacts that end up on your machine as a result of the install.
|
||||
|
||||
|
||||
#### Our samples are provided AS-IS without any warranties of any kind
|
||||
Chocolately has implemented security safeguards in their process to help protect the community from malicious or pirated software, but any use of our scripts is at your own risk. Please read the Chocolately's legal terms of use and the Boxstarter project license as well as how the community repository for Chocolatey.org is maintained.
|
||||
|
||||
Our project is subject to the MIT License and we make no warranties, express or implied of any kind. In no event is Microsoft or contributing copyright holders be liable for any claim, damages or other liability arising from out of or in connection with the use of the project software or the use of other dealings in the project software.
|
||||
|
||||
# Contributing
|
||||
Do you want to contribute? We would love your help. Here are our <a href="CONTRIBUTING.md">contribution guidelines</a>.
|
||||
|
||||
# About this project
|
||||
The goal of this project is to provide a central place to share ideas for streamlining dev box setup and provide sample scripts for common dev scenarios. It's likely you will want to take the scripts here and modify them to fit your particular needs. When you make those changes if you think others would benefit please consider submitting a PR. Before you contribute please see the [Contribution Guidelines](CONTRIBUTING.md).
|
||||
|
||||
These scripts leverage two popular open source projects.
|
||||
- Boxstarter [boxstarter.org](http://boxstarter.org)
|
||||
- Chocolatey [chocolatey.org](http://chocolatey.org)
|
||||
|
||||
## How to run the scripts
|
||||
Before you begin, please read the [Legal](#Legal) section.
|
||||
|
||||
To run a setup script, click a link in the table below from your target machine. This will download Boxstarter, and prompt you for Boxstarter to run with Administrator privileges (which it needs to do its job). Clicking yes in this dialog will cause the script to begin. You can then leave the job unattended and come back when it's finished.
|
||||
|
||||
|Click link to run |Description |
|
||||
|---------|---------|
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_app.ps1?token=AK0OHpRu7iHVJgnn7DsbBumVp2C4ljleks5a9LuJwA%3D%3D'>Desktop App</a> | Windows Desktop App Development (Visual Studio, Windows SDK) |
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_web.ps1?token=AK0OHhoec2cUUr7i0KVnUReiLhzNPGxXks5a9LugwA%3D%3D'>Web</a> | Web (VS Code, Multiple Browsers) |
|
||||
|<a href='http://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/Microsoft/windows-dev-box-setup-scripts/master/dev_web_nodejs.ps1?token=AK0OHg--lXI4lmyAFY_wN2CKxWnUaaSRks5a8VJjwA%3D%3D'>Web NodeJS</a> | Web Dev with NodeJS (Web + NodeJS LTS) |
|
||||
| | Xamarin (Visual Studio, Xamarin, Android SDK) |
|
||||
| | Machine Learning |
|
||||
| | Containers (Kubernetes, etc...) |
|
||||
| | More Coming Soon! |
|
||||
|
||||
## Working with Chocolatey for Organizations?
|
||||
No problem, you can still use these scripts. You'll need to modify the script to reference your internal package store. Here are instructions for doing so:
|
||||
|
||||
[ADD INSTRUCTIONS]
|
||||
|
||||
## Setting up a VM
|
||||
Windows 10 VM setup instructions
|
||||
1. Use Hyper-V's [Quick Create](https://blogs.technet.microsoft.com/virtualization/2017/01/20/a-closer-look-at-vm-quick-create/) to set up a VM
|
||||
2. Once signed in to your VM, visit this project in a web browser and click one of the script links in the Readme
|
||||
|
||||
# Legal
|
||||
Please read before using scripts.
|
||||
|
||||
#### Using our scripts downloads third party software
|
||||
When you use our sample scripts, these will direct to Chocolately to install the packages.
|
||||
By using Chocolatey to install a package, you are accepting the license for the application, executable(s), or other artifacts delivered to your machine as a result of a Chocolatey install. This acceptance occurs whether you know the license terms or not. Read and understand the license terms of any package you plan to install prior to installation through Chocolatey. If you do not want to accept the license of a package you are installing, you need to uninstall the package and any artifacts that end up on your machine as a result of the install.
|
||||
|
||||
|
||||
#### Our samples are provided AS-IS without any warranties of any kind
|
||||
Chocolately has implemented security safeguards in their process to help protect the community from malicious or pirated software, but any use of our scripts is at your own risk. Please read the Chocolately's legal terms of use and the Boxstarter project license as well as how the community repository for Chocolatey.org is maintained.
|
||||
|
||||
Our project is subject to the MIT License and we make no warranties, express or implied of any kind. In no event is Microsoft or contributing copyright holders be liable for any claim, damages or other liability arising from out of or in connection with the use of the project software or the use of other dealings in the project software.
|
||||
|
||||
# Contributing
|
||||
Do you want to contribute? We would love your help. Here are our <a href="CONTRIBUTING.md">contribution guidelines</a>.
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче