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.

Sign up for GitHub

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

Jump to bottom

README - join up with dfeR::create_project() and update to be .md files #108

Closed
3 tasks
cjrace opened this issue Sep 20, 2024 · 1 comment · Fixed by #123
Closed
3 tasks

README - join up with dfeR::create_project() and update to be .md files #108

cjrace opened this issue Sep 20, 2024 · 1 comment · Fixed by #123
Assignees
@Lsnaathorst1
Labels
bug Something isn't working enhancement New feature or request

Comments

@cjrace
Copy link
Contributor

cjrace commented Sep 20, 2024

Currently at https://dfe-analytical-services.github.io/analysts-guide/RAP/rap-statistics.html#writing-a-readme-file, we have this:

image

We should update it a bit as it's not strictly accurate anymore:

  • Switch .txt to .md, and point to some basic markdown guidance as well. Explain / show how .md render nicely in Azure DevOps / GitHub etc
  • Point to the dfeR::create_project() function for how to get started
  • Join up with with the dfeR function / dfeR package more widely so there is a template readme and link to that
@cjrace cjrace added bug Something isn't working enhancement New feature or request labels Sep 20, 2024
@Lsnaathorst1 Lsnaathorst1 self-assigned this Nov 21, 2024
@Lsnaathorst1
Copy link
Contributor

README improved guidance & example

@Lsnaathorst1 Lsnaathorst1 mentioned this issue Nov 26, 2024
Merged
4 tasks
@Lsnaathorst1 Lsnaathorst1 linked a pull request Nov 26, 2024 that will close this issue
108 readme join up with dfercreate project and update to be md files #123
Merged
4 tasks
@Lsnaathorst1 Lsnaathorst1 mentioned this issue Nov 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Lsnaathorst1 Lsnaathorst1

Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Milestone
No milestone
2 participants
@cjrace @Lsnaathorst1