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

README needs refined #27

Open
ewingjm opened this issue Dec 4, 2020 · 1 comment
Open

README needs refined #27

ewingjm opened this issue Dec 4, 2020 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers technical debt

Comments

@ewingjm
Copy link
Member

ewingjm commented Dec 4, 2020

Is your feature request related to a problem? Please describe.

I've noticed a couple of issues with the README that make it appear a little clumsy -

  • Installation section is talking about using the sample projects rather than installing the package - the section's content is also formatted more like Wiki than README content
  • The description header is superfluous
  • The table of contents has only one sub-section under Usage (Obfuscation)
  • Obfuscation is actually a header on the same level as Usage, rather than a sub-header as the ToC suggests
  • Usage instructs people to a create a new console app - this is overly prescriptive and not necessary
  • Obfuscation has its own sub-headers that aren't on the ToC
  • Contributing section should point to the CONTRIBUTING.md file
  • Credits section should probably be removed if we're just crediting ourselves

Describe the solution you'd like

  • Correct the installation section to be about installing the package (probably move the detail about the samples to the Wiki as it bloats the README)
  • Remove the description header and put the descriptive text under the title
  • Move obfuscation under usage and shift a considerable amount of this to the Wiki to avoid bloating the README with only specific features
  • Ensure the ToC is reflective of the actual headings
  • Replace the text in the Credits section with something along the lines of "Please refer to the Contributing guide." (with a link)
  • Remove the credits section
@ewingjm ewingjm added the enhancement New feature or request label Dec 4, 2020
@ewingjm ewingjm added the good first issue Good for newcomers label Jan 13, 2021
@tdashworth
Copy link
Contributor

  • add link(s) to XrmToolbox repo/tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers technical debt
Projects
None yet
Development

No branches or pull requests

3 participants