Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Getting Started #1420

Open
Keboo opened this issue Sep 20, 2019 · 3 comments

Comments

@Keboo
Copy link
Member

@Keboo Keboo commented Sep 20, 2019

Right now the Getting Started section in the README is a bit outdated.

People who are just getting started with this library are not likely to have all of the dependencies needed (latest version of VS, .NET Core, etc.) to compile the source code and demo application.

I am looking for people newer to this project to either comment or submit a PR with suggestions on how to improve this.

Some ideas to consider:

  • Getting started section so that it is as simple as possible for someone new to the library.
  • Consider including a link to my examples repo
  • Consider moving up the link to the releases page with the pre-compiled demo app from the See It In Action section
  • Remove the Source Code section and instead simply link over to the wiki page
@Taschenbuch

This comment has been minimized.

Copy link

@Taschenbuch Taschenbuch commented Sep 22, 2019

I think it is important to list the executable demo first before mentioning the compilable demo code. "here, you can try this. It runs out of the box. And if you want to compile it yourself: here is the code, but you need this and that".

The wiki ends with a link to the demo code. A link to the executable could be included right before the code link, i think:
https://github.com/MaterialDesignInXAML/MaterialDesignInXamlToolkit/wiki/Getting-Started

@Keboo Keboo added the Hacktoberfest label Sep 23, 2019
@BJohnsonDev

This comment has been minimized.

Copy link

@BJohnsonDev BJohnsonDev commented Sep 26, 2019

The Configuring your Windows section has a duplicate section within the same page.

The duplicate sections each use a different BackgroundBrush in their examples but are otherwise identical. One of these should be removed.

@bender2k14

This comment has been minimized.

Copy link
Contributor

@bender2k14 bender2k14 commented Nov 13, 2019

The Configuring your Windows section has a duplicate section within the same page.

The duplicate sections each use a different BackgroundBrush in their examples but are otherwise identical. One of these should be removed.

Oh, I was just going to create a new issue about this duplication. I am glad I found this issue.

FWIW, the duplication was added in this commit and a diff of those two sections (using line numbers relative to that first line in each section) is

7c7
<         Background="{DynamicResource MaterialDesignBackground}"
---
>         Background="{DynamicResource MaterialDesignPaper}"
16c16
<         Background="{DynamicResource MaterialDesignBackground}"
---
>         Background="{DynamicResource MaterialDesignPaper}"

where the the left/first file in the diff is the first occurance of the "Configuring your Window(s)" section (so the right/second file in the diff is the second occurance of the section).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.