From 33b043b56dcd1c979e2ff9157d07fb40245ad593 Mon Sep 17 00:00:00 2001 From: vegu-ai-tools <152010387+vegu-ai-tools@users.noreply.github.com> Date: Mon, 11 Dec 2023 21:12:34 +0200 Subject: [PATCH] docs --- README.md | 5 ++--- docs/troubleshoot.md | 8 ++++++++ 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 docs/troubleshoot.md diff --git a/README.md b/README.md index 4d666517..d442d62b 100644 --- a/README.md +++ b/README.md @@ -66,15 +66,14 @@ In no particular order: Post [here](https://github.com/vegu-ai/talemate/issues/17) if you run into problems during installation. +There is also a [troubleshooting guide](docs/troubleshoot.md) that might help. + ### Windows 1. Download and install Python 3.10 or Python 3.11 from the [official Python website](https://www.python.org/downloads/windows/). :warning: python3.12 is currently not supported. 1. Download and install Node.js from the [official Node.js website](https://nodejs.org/en/download/). This will also install npm. 1. Download the Talemate project to your local machine. Download from [the Releases page](https://github.com/vegu-ai/talemate/releases). 1. Unpack the download and run `install.bat` by double clicking it. This will set up the project on your local machine. - - :warning: If your installation errors with a notification to upgrade "Microsoft Visual C++" go to https://visualstudio.microsoft.com/visual-cpp-build-tools/ and click "Download Build Tools" and run it. - - During installation make sure you select the C++ development package (upper left corner) - - Run `reinstall.bat` inside talemate directory 1. Once the installation is complete, you can start the backend and frontend servers by running `start.bat`. 1. Navigate your browser to http://localhost:8080 diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md new file mode 100644 index 00000000..7aef3b9a --- /dev/null +++ b/docs/troubleshoot.md @@ -0,0 +1,8 @@ +# Windows + +## Installation fails with "Microsoft Visual C++" error + +If your installation errors with a notification to upgrade "Microsoft Visual C++" go to https://visualstudio.microsoft.com/visual-cpp-build-tools/ and click "Download Build Tools" and run it. + +- During installation make sure you select the C++ development package (upper left corner) +- Run `reinstall.bat` inside talemate directory \ No newline at end of file