diff --git a/README.md b/README.md index 4c5c163..13ffcf8 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# private-data-lookup \ No newline at end of file +# Private Data Lookup + +[![commit messages](https://github.com/csirianni/private-data-lookup/actions/workflows/commits.yml/badge.svg)](https://github.com/csirianni/movie-recommender/actions/workflows/commits.yml) + +## Overview + +## Instructions + +It's necessary to configure the `/frontend` and `/backend` folders initially. See the respective `README.md`s for more information. + +In order to run the frontend, `cd` into `/frontend` and run + +```console +yarn dev +``` + +In order to run the backend, `cd` into the `/backend` and run + +```console +./build/backend +``` diff --git a/backend/README.md b/backend/README.md index 159cd9a..e5164dc 100644 --- a/backend/README.md +++ b/backend/README.md @@ -9,7 +9,7 @@ brew install conan cmake conan install . --output-folder=build --build=missing ``` -Set up the `/build/` folder: +Set up the `/build` folder: ```bash mkdir build && cd build