From 044b89f4abeda76201c8297c1a26b83a3b1a894e Mon Sep 17 00:00:00 2001 From: LiFaytheGoblin Date: Sat, 27 May 2017 17:47:55 +0200 Subject: [PATCH] Readme update for windows users who have difficulties getting the standalone web client to work --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index de28c6d78..b97b54a6d 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,7 @@ make deploy ### Current issues with the development We're currently in the process of transitioning into this web client from Scratch's existing structure. As we transition, there are going to be some issues along the way that relate to how this client needs to interact with the existing infrastructure to work properly in production. +#### FALLBACK #### On top of migrating to using this as our web client, Scratch is also transitioning into using a new API backend, Scratch REST API. As that is also currently in development and incomplete, we are set up to fall back to using existing Scratch endpoints if an API endpoint does not exist – which is where the `FALLBACK` comes in. Most of the issues we have currently revolve around the use of `FALLBACK`. This variable is used to specify what url to fall back onto should a request fail within the context of this webclient, or when using the `API_HOST`. If not specified in the process, it will not be used, and any request that is not made through the web client or the API will be unreachable. @@ -112,3 +113,5 @@ Setting `FALLBACK=https://scratch.mit.edu` allows the web client to retrieve dat Additionally, if you set `FALLBACK=https://scratch.mit.edu`, be aware that clicking on links to parts of the website not yet migrated over (currently such as `Explore`, `Discuss`, `Profile`, etc.) will take you to the Scratch website itself. +#### Windows #### +Some users have experienced difficulties when trying to get our web client to work on Windows. One solution could be to use [Cygwin](https://www.cygwin.com/). If that doesn't work, you might want to use [Wubi](https://wiki.ubuntu.com/WubiGuide) (Windows XP, Vista, 7) or [Wubiuefi](https://github.com/hakuna-m/wubiuefi) (Windows 8 or higher). Wubi(uefi) is a Windows Installer for Ubuntu that allows you to have Ubuntu and Windows on one disk, without the need of an extra partition. \ No newline at end of file