Reducing redundancies with contributing.md and updating README
This commit is contained in:
Родитель
f66580e4a1
Коммит
334cb11b55
|
@ -1,14 +0,0 @@
|
|||
# Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to
|
||||
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
|
||||
and actually do, grant us the rights to use your contribution. For details, visit
|
||||
https://cla.microsoft.com.
|
||||
|
||||
When you submit a pull request, a CLA-bot will automatically determine whether you need
|
||||
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
|
||||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
23
README.md
23
README.md
|
@ -48,8 +48,8 @@ numpy==1.16.4
|
|||
matplotlib==3.0.3
|
||||
pandas==0.25.1
|
||||
scipy==1.3.0
|
||||
microsoft-bonsai-api==0.1.1
|
||||
bonsai-cli==1.0.0
|
||||
microsoft-bonsai-api==0.1.2
|
||||
bonsai-cli==1.0.1
|
||||
```
|
||||
|
||||
### 4. Run the Script
|
||||
|
@ -70,20 +70,25 @@ The application will prompt you for responses, an example may look like the foll
|
|||
```bash
|
||||
Is windows or linux required to run Simulator?: windows
|
||||
Directory of Simulator integration files: sample/
|
||||
What is the name of the file with microsoft bonsai api? (e.g., __main__.py): __main__.py
|
||||
What is the name of the file with microsoft bonsai api? (e.g., main.py): main.py
|
||||
Directory of requirements.txt: .
|
||||
Image Name (No underscores): my-first-sim
|
||||
Name of the ACR (without azurecr.io: mydemo
|
||||
Name of the ACR (without azurecr.io): mydemo
|
||||
```
|
||||
|
||||
## Contribute Code
|
||||
This project welcomes contributions and suggestions. Most contributions require you to
|
||||
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
|
||||
and actually do, grant us the rights to use your contribution. For details, visit
|
||||
https://cla.microsoft.com.
|
||||
|
||||
When you submit a pull request, a CLA-bot will automatically determine whether you need
|
||||
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
|
||||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
If you would like to become an active contributor to this project please
|
||||
follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines.html).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
## Telemetry
|
||||
The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
|
||||
|
|
Загрузка…
Ссылка в новой задаче