diff --git a/README.md b/README.md index 287a7d0..f33aeda 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # vistassh-py -Python-based web interface for VistA roll-and-scroll terminal \ No newline at end of file +Python-based web interface for VistA roll-and-scroll terminal + +## Getting started + +You will need: +- Python 3.10+ & pip +- Node.js & npm + +To install the dependencies and build the frontend, perform the following steps: + +```bash +pip install -r requirements.txt +cd frontend +npm install +npm run build +``` + +To run, invoke `main.py`. \ No newline at end of file