DevWiki/calculator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2 from mcooley/doc-updates

Browse Source 
Update documentation for GitHub
This commit is contained in:
Matt Cooley 2019-01-29 11:56:05 -08:00 committed by GitHub
commit 8a5bf1173e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -17,13 +17,11 @@ all community interactions must abide by the [Code of Conduct](CODE_OF_CONDUCT.m
## Finding issues you can help with ## Finding issues you can help with
Looking for something to work on? Looking for something to work on?
[Issues marked *up for grabs*](https://microsoft.com/#TODO_MIGRATE_THIS_LINK_AFTER_GITHUB_MIGRATION) [Issues marked *good first issue*](https://github.com/Microsoft/calculator/labels/good%20first%20issue)
are a good place to start. are a good place to start.
Another way you can help is by reproducing issues others have reported. You can also check [the *help wanted* tag](https://github.com/Microsoft/calculator/labels/help%20wanted)
[Issues marked *more info needed*](https://microsoft.com/#TODO_MIGRATE_THIS_LINK_AFTER_GITHUB_MIGRATION) to find other issues to help with.
don't have all the information needed to take action. You can try to reproduce the issue on your
machine and add more details so we can take action on the report.
## Contributions we accept ## Contributions we accept
We welcome your contributions to the Calculator project, especially to fix bugs and to make We welcome your contributions to the Calculator project, especially to fix bugs and to make
@ -79,7 +77,7 @@ participate in the review, but at least one member of the Calculator team will u
the request. the request.
Often, multiple iterations will be needed to responding to feedback from reviewers. Try looking at Often, multiple iterations will be needed to responding to feedback from reviewers. Try looking at
[past pull requests](https://microsoft.com/#TODO_MIGRATE_THIS_LINK_AFTER_GITHUB_MIGRATION) to see [past pull requests](https://github.com/Microsoft/calculator/pulls?q=is%3Apr+is%3Aclosed) to see
what the experience might be like. what the experience might be like.
## Contributor License Agreement ## Contributor License Agreement

44
README.md
View File

@ -4,10 +4,10 @@ The app provides standard, scientific, and programmer calculator functionality,
Calculator ships regularly with new features and bug fixes. You can get the latest version of Calculator in the [Windows Store.](https://www.microsoft.com/store/apps/9WZDNCRFHVN5) Calculator ships regularly with new features and bug fixes. You can get the latest version of Calculator in the [Windows Store.](https://www.microsoft.com/store/apps/9WZDNCRFHVN5)
<!-- TODO: Replace with something else or remove if builds are not public --> <!-- TODO: Replace with badge from public pipeline -->
[![Build Status](https://microsoft.visualstudio.com/Apps/_apis/build/status/Utility%20Apps/Calculator-Daily)](https://microsoft.visualstudio.com/Apps/_build?definitionId=3539) [![Build Status](https://microsoft.visualstudio.com/Apps/_apis/build/status/Utility%20Apps/Calculator-Daily)](https://microsoft.visualstudio.com/Apps/_build?definitionId=3539)
![Calculator Screenshot](\docs\Images\CalculatorScreenshot.png) ![Calculator Screenshot](docs/Images/CalculatorScreenshot.png)
## Features ## Features
- Standard Calculator functionality which offers basic operations and evaluates commands immediately as they are entered. - Standard Calculator functionality which offers basic operations and evaluates commands immediately as they are entered.
@ -25,47 +25,19 @@ Prerequisites:
- Install the optional "C++ Universal Windows Platform tools" component - Install the optional "C++ Universal Windows Platform tools" component
- Install the latest Windows 10 SDK - Install the latest Windows 10 SDK
![Visual Studio Installation Screenshot](\docs\Images\VSInstallationScreenshot.png) ![Visual Studio Installation Screenshot](docs/Images/VSInstallationScreenshot.png)
- Install the [XamlStyler](https://marketplace.visualstudio.com/items?itemName=TeamXavalon.XAMLStyler) Visual Studio extension - Install the [XamlStyler](https://marketplace.visualstudio.com/items?itemName=TeamXavalon.XAMLStyler) Visual Studio extension
<!-- TODO: Replace with external link -->
- Get the code: - Get the code:
``` ```
git clone https://microsoft.visualstudio.com/DefaultCollection/Apps/_git/calculator.app git clone https://github.com/Microsoft/calculator.git
``` ```
- Open [src\Calculator.sln](\src\Calculator.sln) in Visual Studio to build and run the Calculator app. - Open [src\Calculator.sln](/src/Calculator.sln) in Visual Studio to build and run the Calculator app.
- For a general description of the Calculator project architecture see [ApplicationArchitecture.md](docs\ApplicationArchitecture.md). - For a general description of the Calculator project architecture see [ApplicationArchitecture.md](docs/ApplicationArchitecture.md).
## Running Tests
To run tests in Visual Studio, install [TDP](https://osgwiki.com/wiki/TDP) <!-- TODO 19570630: Replace with internal docs or remove once we know what we are doing with tests --> and use the TAEF explorer pane.
Calculator has two primary sets of tests:
- [CalculatorUnitTests.vcxproj](\src\CalculatorUnitTests\CalculatorUnitTests.vcxproj) - Unit Tests
- [UIAutomationTests.csproj](\src\UIAutomationTests\UIAutomationTests.csproj) - UI Automation using [MitaLite](http://osgwiki.com/mitalite) <!-- TODO: Replace with link to the MitaLite open source repository -->
## Exploring the repo
- [Build](\build) - Scripts which run during the build
- [Docs](\Docs) - Documentation for developers
- [Loc](\Loc) - Localization settings and files
- [PDP](\PDP) - Information about the app for the Store's Product Description Page
- [SpkgDefs](\SpkgDefs) - Definitions for building [test packages](https://osgwiki.com/wiki/Test_Package) <!-- TODO: Replace with external link or remove once we know what we are doing with tests -->
- [Src](\src) - Main folder for source code
- [Tools](\tools) - Scripts and tools to aid in development
- [TRexDefs](\TRexDefs) - Definitions for running tests using [TReX](https://osgwiki.com/wiki/TReX) <!-- TODO: Replace with external link or remove once we know what we are doing with tests -->
## Contributing ## Contributing
Want to contribute? The team encourages community feedback and contributions. Please follow our [contributing guidelines](\CONTRIBUTING.md). Want to contribute? The team encourages community feedback and contributions. Please follow our [contributing guidelines](CONTRIBUTING.md).
If Calculator is not working properly, please file a report in the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130). If Calculator is not working properly, please file a report in the [Feedback Hub](https://insider.windows.com/en-us/fb/?contextid=130).
If you want to submit an issue to this repository, please read the We also welcome [issues submitted on GitHub](https://github.com/Microsoft/calculator/issues).
[issue reporting guidelines](\IssueTracking.md).
<!-- Uncomment when we finalize licensing
# License
The Calculator project is released under the *Insert license info and link here*
-->
<!-- TODO: Remove or replace with the decided on external mechanism to contact the team -->
## Contact
Questions? Reach out to the PAX Essential Experiences App email alias: <paxeeapps@microsoft.com>

34
docs/ApplicationArchitecture.md
View File

@ -151,20 +151,20 @@ The Model for the Calculator modes is contained in the [CalcManager][CalcManager
[XAML Overview]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/xaml-overview [XAML Overview]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/xaml-overview
[MVVM]: https://docs.microsoft.com/en-us/windows/uwp/data-binding/data-binding-and-mvvm [MVVM]: https://docs.microsoft.com/en-us/windows/uwp/data-binding/data-binding-and-mvvm
[Calculator folder]: ..\src\Calculator [Calculator folder]: ../src/Calculator
[App.xaml]: ..\src\Calculator\App.xaml [App.xaml]: ../src/Calculator/App.xaml
[App.xaml.cpp]: ..\src\Calculator\App.xaml.cpp [App.xaml.cpp]: ../src/Calculator/App.xaml.cpp
[StaticResource]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/staticresource-markup-extension [StaticResource]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/staticresource-markup-extension
[ThemeResource]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/themeresource-markup-extension [ThemeResource]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/themeresource-markup-extension
[Page]: https://docs.microsoft.com/en-us/uwp/api/Windows.UI.Xaml.Controls.Page [Page]: https://docs.microsoft.com/en-us/uwp/api/Windows.UI.Xaml.Controls.Page
[UserControl]: https://docs.microsoft.com/en-us/uwp/api/Windows.UI.Xaml.Controls.UserControl [UserControl]: https://docs.microsoft.com/en-us/uwp/api/Windows.UI.Xaml.Controls.UserControl
[MainPage.xaml]: ..\src\Calculator\Views\MainPage.xaml [MainPage.xaml]: ../src/Calculator/Views/MainPage.xaml
[Calculator.xaml]: ..\src\Calculator\Views\Calculator.xaml [Calculator.xaml]: ../src/Calculator/Views/Calculator.xaml
[CalculatorStandardOperators.xaml]: ..\src\Calculator\Views\CalculatorStandardOperators.xaml [CalculatorStandardOperators.xaml]: ../src/Calculator/Views/CalculatorStandardOperators.xaml
[CalculatorScientificOperators.xaml]: ..\src\Calculator\Views\CalculatorScientificOperators.xaml [CalculatorScientificOperators.xaml]: ../src/Calculator/Views/CalculatorScientificOperators.xaml
[CalculatorProgrammerOperators.xaml]: ..\src\Calculator\Views\CalculatorProgrammerOperators.xaml [CalculatorProgrammerOperators.xaml]: ../src/Calculator/Views/CalculatorProgrammerOperators.xaml
[DateCalculator.xaml]: ..\src\Calculator\Views\DateCalculator.xaml [DateCalculator.xaml]: ../src/Calculator/Views/DateCalculator.xaml
[UnitConverter.xaml]: ..\src\Calculator\Views\UnitConverter.xaml [UnitConverter.xaml]: ../src/Calculator/Views/UnitConverter.xaml
[VisualState]: https://docs.microsoft.com/en-us/windows/uwp/design/layout/layouts-with-xaml#adaptive-layouts-with-visual-states-and-state-triggers [VisualState]: https://docs.microsoft.com/en-us/windows/uwp/design/layout/layouts-with-xaml#adaptive-layouts-with-visual-states-and-state-triggers
[Style]: https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/xaml-styles [Style]: https://docs.microsoft.com/en-us/windows/uwp/design/controls-and-patterns/xaml-styles
@ -175,14 +175,14 @@ The Model for the Calculator modes is contained in the [CalcManager][CalcManager
[Binding]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/binding-markup-extension [Binding]: https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/binding-markup-extension
[BindingComparison]: https://docs.microsoft.com/en-us/windows/uwp/data-binding/data-binding-in-depth#xbind-and-binding-feature-comparison [BindingComparison]: https://docs.microsoft.com/en-us/windows/uwp/data-binding/data-binding-in-depth#xbind-and-binding-feature-comparison
[CalcViewModel folder]: ..\src\CalcViewModel [CalcViewModel folder]: ../src/CalcViewModel
[ApplicationViewModel.h]: ..\src\CalcViewModel\ApplicationViewModel.h [ApplicationViewModel.h]: ../src/CalcViewModel/ApplicationViewModel.h
[StandardCalculatorViewModel.h]: ..\src\CalcViewModel\StandardCalculatorViewModel.h [StandardCalculatorViewModel.h]: ../src/CalcViewModel/StandardCalculatorViewModel.h
[DateCalculatorViewModel.h]: ..\src\CalcViewModel\DateCalculatorViewModel.h [DateCalculatorViewModel.h]: ../src/CalcViewModel/DateCalculatorViewModel.h
[UnitConverterViewModel.h]: ..\src\CalcViewModel\UnitConverterViewModel.h [UnitConverterViewModel.h]: ../src/CalcViewModel/UnitConverterViewModel.h
[INotifyPropertyChanged]: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.data.inotifypropertychanged [INotifyPropertyChanged]: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.data.inotifypropertychanged
[PropertyChanged]: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.data.inotifypropertychanged.propertychanged [PropertyChanged]: https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.data.inotifypropertychanged.propertychanged
[Utils.h]: ..\src\CalcViewModel\Common\Utils.h [Utils.h]: ../src/CalcViewModel/Common/Utils.h
[CalcManager folder]: ..\src\CalcManager [CalcManager folder]: ../src/CalcManager