From 62da869eee19f4a48dfa775b808b11a0c0ebd5ce Mon Sep 17 00:00:00 2001 From: Dominik Picheta Date: Sun, 5 Jun 2016 14:10:13 +0100 Subject: [PATCH] Added more information to the download.rst page. Fixes #4022. --- web/download.rst | 49 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 13 deletions(-) diff --git a/web/download.rst b/web/download.rst index cffad4ac95..774f4d017c 100644 --- a/web/download.rst +++ b/web/download.rst @@ -12,10 +12,14 @@ and Clang on Mac. Binaries -------- -Unfortunately for now we only provide builds for Windows. +Unfortunately, right now we only provide binaries for Windows. You can download +an installer for both 32 bit and 64 bit versions of Windows below. + * 32 bit: `nim-0.13.0_x32.exe `_ * 64 bit: `nim-0.13.0_x64.exe `_ +These installers also include Aporia, Nimble and other useful Nim tools to get +you started with Nim development! Installation based on generated C code -------------------------------------- @@ -24,33 +28,52 @@ This installation method is the preferred way for Linux, Mac OS X, and other Uni like systems. Binary packages may be provided later. -Download this: +Firstly, download this archive: * `nim-0.13.0.tar.xz (3.1MB) `_ -Extract the file and follow these instructions: +Extract the archive. Then copy the extracted files into your chosen installation +directory, ideally somewhere in your home directory. +For example: ``~/programs/nim``. -* sh build.sh +Now open a terminal and follow these instructions: + +* ``cd`` into your installation directory, for example by executing +``cd ~/programs/nim``. +* run ``sh build.sh``. * Add ``$your_install_dir/bin`` to your PATH. +After restarting your terminal, you should be able to run ``nim -v`` +which should show you the version of Nim you just installed. + There are other ways to install Nim (like using the ``install.sh`` script), but these tend to cause more problems. -Installation from github ------------------------- +Bleeding edge installation from GitHub +-------------------------------------- -Use the following commands to build the compiler from source. -Change the branch to suit your needs:: +`GitHub `_ is where Nim's development takes +place. You may wish to grab the latest development version of Nim, because +sometimes bug fixes and new features may not have made it to an official +release yet. In those circumstances you are better off grabbing the +current development branch. - git clone -b master git://github.com/nim-lang/Nim.git +You will also need to do this if you would like to contribute to Nim. + +Before you download the code, open a new terminal and ``cd`` into the +directory where you would like the download to take place. + +The following commands can be used to download the current development branch +and then to build it:: + + git clone git://github.com/nim-lang/Nim.git cd Nim - git clone -b master --depth 1 git://github.com/nim-lang/csources + git clone --depth 1 git://github.com/nim-lang/csources cd csources && sh build.sh cd .. bin/nim c koch ./koch boot -d:release -The ``master`` branch always contains the latest stable version of the compiler. -If you want bleeding edge then switch to the ``devel`` branch and follow -the same instructions outlined above. +You should then add the ``./bin`` (make sure to expand this into an +absolute path) directory to your ``PATH``.