Readme file with instructions

2024-03-21 17:39:59 -04:00
parent cbf9767377
commit 40c3c29019
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,14 @@
+GCF (and LCM) Practice
+===
+This is a simple app to practice on greatest common factor (GCF) and least
+common multiple (LCM) math problems.
+
+Compiling
+---
+Install dependencies with `yarn install`. Compile the app with `yarn build`.
+The build script will compile into `./dist`.
+
+Developing
+---
+Install dependencies with `yarn install`. Run the local development server
+with `yarn dev`.