Merge pull request #4 from zommerfelds/patch-1

Improve Windows setup instructions

Author: jeremyfa

content/guides/02-getting-started/01-install-ceramic.md

@@ -15,7 +15,7 @@ Here you are, getting for the first time your hands dirty with Ceramic!
 
 ## Install Haxe
 
-[Download and install latest Haxe](https://haxe.org/download/).
+[Download and install latest Haxe](https://haxe.org/download/) (Haxe 5 preview is not yet supported).
 
 <p>
 <img src="/static/img/download-haxe.png" alt="Haxe download page" />
@@ -26,17 +26,21 @@ Simply download and run the Haxe installer and follow the instructions.
 
 The rest of the article assumes you are able to understand basic Haxe programming. If you are new to Haxe, you can take a look at the [Haxe introduction](https://haxe.org/documentation/introduction/) and the many resources it provides from the Haxe Foundation.
 
+<p class="extra-info">Ceramic is currently only compatible with Haxelib 4.0.3. Please make sure to run <code>haxelib set haxelib 4.0.3</code> before proceeding.</p>
+
 ## Install Ceramic
 
-A lot of things are done on the command line with Ceramic. We will enter command line instruction with the **Terminal** app on mac and linux, or with **Powershell** on windows. You need to be familiar with command line tools to continue.
+A lot of things are done on the command line with Ceramic. We will enter command line instruction with the **Terminal** app on Mac and Linux, or with **Powershell** on Windows. You need to be familiar with command line tools to continue.
+
+### Linux
 
-The easiest way to install Ceramic is via [haxelib](https://lib.haxe.org/p/ceramic/). Open the terminal and type:
+The easiest way to install Ceramic on Linux is via [haxelib](https://lib.haxe.org/p/ceramic/). Open the terminal and type:
 
 ```bash
 haxelib install ceramic
 ```
 
-This should have installed a setup utility on your machine. You can now enter a second command to download the actual ceramic package and install it:
+This should have installed a setup utility on your machine. You can now enter a second command to download the actual Ceramic package and install it:
 
 ```bash
 haxelib run ceramic setup
@@ -46,9 +50,15 @@ Follow the instructions, it will tell you where it wants to install Ceramic and
 
 <p class="extra-info">When it asks you if you want to make <code>ceramic</code> command available globally, you should choose <code>yes</code> so that the <code>ceramic</code> command will work by default on any command line session from any folder on your computer.</p>
 
-<p class="extra-info">On Mac and Linux, depending on the permissions settings of your machine, you might need to run the setup with administrator rights: <code>sudo haxelib run ceramic setup</code>.</p>
+<p class="extra-info">Depending on the permissions settings of your machine, you might need to run the setup with administrator rights: <code>sudo haxelib run ceramic setup</code>.</p>
+
+### Windows & Mac
+
+On Windows or Mac, the best way to install Ceramic is to download and run the corresponding package (`ceramic-windows-installer.exe` or `ceramic-mac-installer.pkg`) from the [latest release](https://github.com/ceramic-engine/ceramic/releases). Make sure not to have spaces in the installation path (current limitation).
+
+### Verifying the installation
 
-After the command has finished installing, you can check that Ceramic is working by typing:
+You can check that Ceramic is working by typing in the command line:
 
 ```bash
 ceramic
@@ -60,6 +70,6 @@ If you get a similar display as below, that means ceramic has been successfully
 
 ![Ceramic CLI](/static/img/ceramic-cli.png)
 
-<p class="extra-info">Installing Haxe (and haxelib) on your computer was required to follow this guide as we install Ceramic via haxelib, but note that Ceramic is mostly self-contained. It embeds its own versions of haxe, node & electron so that it won’t break if you update something on your computer. Projects generated by Ceramic contain their own local haxelib repository and are configured to use Ceramic’s embedded haxe for code completion and compilation.<p>
+<p class="extra-info">Installing Haxe (and haxelib) on your computer was required to follow this guide as we install Ceramic via haxelib, but note that Ceramic is mostly self-contained. It embeds its own versions of haxe, node & electron so that it won’t break if you update something on your computer. Projects generated by Ceramic contain their own local haxelib repository and are configured to use Ceramic’s embedded haxe for code completion and compilation.</p>
 
-<p class="extra-info">Another note to Haxe developers using <a href="https://github.com/lix-pm/lix.client">lix</a>: Ceramic is not designed to work with lix. Creating a lix scope inside a Ceramic project is not supported. That said, a standard Ceramic project should work and compile fine even if your global haxe installation is running via lix, thanks to Ceramic being packed with everything it needs already.<p>
+<p class="extra-info">Another note to Haxe developers using <a href="https://github.com/lix-pm/lix.client">lix</a>: Ceramic is not designed to work with lix. Creating a lix scope inside a Ceramic project is not supported. That said, a standard Ceramic project should work and compile fine even if your global haxe installation is running via lix, thanks to Ceramic being packed with everything it needs already.</p>