Roll a readme

Author: coatless

README.md

@@ -1,2 +1,55 @@
-# 2d-random-walk
-Demonstrate random walk
+# 2D Random Walk
+
+The 2D Random Walk is a web-based application that allows for the exploration of
+random walks. The application is built with
+R Shiny and deployed using shinylive. Check out the live application at
+<https://shiny.thecoatlessprofessor.com/2d-random-walk/>
+
+With the shiny app, you can:
+
+- Specify the type of walk: Cardinal, Diagonal, or Normal;
+- Adjust the step size;
+- Manually take one step;
+- Automatically take steps;
+- Visualize the trajectory of the walk; and
+- See statistics about the walk.
+
+## Deployment
+
+This application is deployed using shinylive, allowing it to run directly in
+the browser without requiring an R server. Shinylive converts the R code to 
+WebAssembly, making it possible to run R applications entirely client-side.
+
+## Local Development Environment
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/coatless-shiny/2d-random-walk.git
+```
+
+2. Open the `central-limit-theorem.Rproj`
+
+3. Install required R packages:
+
+```r
+install.packages(c("shiny", "ggplot2", "bslib", "bsicons", "shinylive"))
+```
+
+4. Run the application:
+
+```r
+shiny::runApp()
+```
+
+5. Check if the application can be converted to `{shinylive}`:
+
+```r
+shinylive::export(".", "_site")
+```
+
+## Acknowledgments
+
+- Built using the R Shiny framework
+- Uses the bslib package for Bootstrap 5 theming
+- Deployed using shinylive for browser-based execution