Update README.md

Author: DiogoRibeiro7

README.md

@@ -1,2 +1,168 @@
-# myRpackage
-A starter R package scaffold, structured for publication on CRAN, with boilerplate files and metadata to begin development immediately.
+# myrpackage
+
+A starter R package scaffold, structured for publication on [CRAN](https://cran.r-project.org/), with boilerplate files and metadata to begin development immediately.
+
+---
+
+## 📁 File Tree
+
+```text
+myrpackage/
+├── DESCRIPTION               # Package metadata
+├── NAMESPACE                # Generated from roxygen2 docs
+├── R/
+│   └── hello.R              # Example R function with documentation
+├── man/
+│   └── hello.Rd             # Generated manual file
+├── tests/
+│   └── testthat/
+│       └── test-hello.R     # Unit test
+│   └── testthat.R           # Testthat runner setup
+├── vignettes/
+│   └── intro.Rmd            # Long-form documentation (optional)
+├── .Rbuildignore            # Files ignored during build
+├── .gitignore               # Git ignore rules
+├── LICENSE                  # Open-source license (MIT recommended)
+└── README.md                # Project overview and usage
+```
+
+---
+
+## 📦 DESCRIPTION (Example)
+
+```r
+Package: myrpackage
+Type: Package
+Title: What the Package Does (One Line, Title Case)
+Version: 0.0.0.9000
+Authors@R:
+    person(given = "First", family = "Last", email = "[email protected]", role = c("aut", "cre"))
+Description: A short description of what the package does.
+License: MIT + file LICENSE
+Encoding: UTF-8
+LazyData: true
+RoxygenNote: 7.3.0
+```
+
+---
+
+## 📄 R/hello.R
+
+```r
+#' Say Hello
+#'
+#' This function prints a friendly greeting.
+#'
+#' @return No return value, called for side effects.
+#' @export
+hello <- function() {
+  print("Hello, world!")
+}
+```
+
+---
+
+## 🧪 tests/testthat/test-hello.R
+
+```r
+test_that("hello() prints correctly", {
+  expect_output(hello(), "Hello, world!")
+})
+```
+
+---
+
+## 📄 tests/testthat.R
+
+```r
+library(testthat)
+library(myrpackage)
+
+test_check("myrpackage")
+```
+
+---
+
+## 📄 .Rbuildignore
+
+```text
+^README\.md$
+^\.gitignore$
+^\.Rproj\.user$
+^\.Rhistory$
+^\.RData$
+^\.DS_Store$
+^vignettes/
+```
+
+---
+
+## 📄 LICENSE (MIT Example)
+
+```
+MIT License
+
+Copyright (c) 2025 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy...
+```
+
+---
+
+## 📄 vignettes/intro.Rmd (Optional)
+
+````rmd
+---
+title: "Getting Started with myrpackage"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Getting Started}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r setup, include = FALSE}
+library(myrpackage)
+````
+
+This is an introduction to using the package.
+
+````
+
+---
+
+## 🚀 Development Workflow
+
+1. **Set up the package in RStudio or manually**:
+   ```r
+   usethis::create_package("myrpackage")
+   usethis::use_git()
+   usethis::use_mit_license()
+   usethis::use_roxygen_md()
+   usethis::use_testthat()
+   devtools::document()
+````
+
+2. **Check your package**:
+
+   ```r
+   devtools::check()
+   ```
+
+3. **Install locally**:
+
+   ```r
+   devtools::install()
+   ```
+
+4. **Submit to CRAN**:
+
+   ```r
+   devtools::release()
+   ```
+
+---
+
+## ✅ Summary
+
+This scaffold provides everything needed to start building an R package with good development hygiene, testing, documentation, and CRAN readiness.