.. index:: 
	single: Building From Source Code; Introduction

=========================
Building From Source Code
=========================

The Ring programming language is a free open source product (MIT License).

You can build Ring using CMake or using Scripts (Batch Files or Shell Scripts).

The next steps explains building using scripts.

.. index:: 
	pair: Building From Source Code; Building using Microsoft Windows

Building using Microsoft Windows
================================

Get the source code

.. code-block:: ring

	git clone http://github.com/ring-lang/ring.git

Build Ring (Compiler/VM)

.. code-block:: ring

	cd ring/src
	buildvccomplete.bat

Generate RingAllegro Source Code and Build

.. code-block:: ring

	cd ../extensions/ringallegro
	gencode.bat
	buildvc.bat

Generate RingLibCurl Source Code and Build

.. code-block:: ring

	cd ../extensions/ringcurl
	gencode.bat
	buildvc.bat

Install Qt 5.5 : https://download.qt.io/archive/qt/5.5/5.5.1/

Generate RingQt Source Code and Build

.. code-block:: ring

	cd ../ringqt
	gencode.bat
	buildmingw32.bat

To be able to call ring from any folder

.. code-block:: ring

	cd ../../bin
	install.bat

Add Ring/bin to System path

.. code-block:: ring

	Hit "windows key".
	Type "Edit the System environment variables"
	Select "Advanced" tab.
	Click on "Enviroment Variables..."
	Double click on "Path"
	Add at the end the new path separated by semicolon. 
	    ;C:\Ring\Bin

Run Ring Notepad

.. code-block:: ring

	cd applications/rnote
	ring rnote.ring

.. index:: 
	pair: Building From Source Code; Building using Ubuntu Linux

Building using Ubuntu Linux
===========================

Get the source code

.. code-block:: ring

	git clone http://github.com/ring-lang/ring.git

Install Libraries

.. code-block:: ring

	cd ring/src
	./installdep.sh 

Build Ring (Compiler/VM)

.. code-block:: ring

	sudo ./buildgcccomplete.sh

Generate RingAllegro Source Code and Build

.. code-block:: ring

	cd ../extensions/ringallegro
	./gencode.sh
	./buildgcc.sh

Generate RingLibCurl Source Code and Build

.. code-block:: ring

	cd ../extensions/ringcurl
	./gencode.sh
	./buildgcc.sh

Generate RingQt Source Code and Build

.. code-block:: ring

	cd ../ringqt
	./gencode.sh
	./buildgcc.sh

To be able to call ring from any folder

.. code-block:: ring

	cd ../../bin
	sudo ./install.sh

Run Ring Notepad

.. code-block:: ring

	cd applications/rnote
	sudo ring rnote.ring

.. index:: 
	pair: Building From Source Code; Building using MacOS X

Building using MacOS X
======================

Get the source code

.. code-block:: ring

	git clone http://github.com/ring-lang/ring.git

Install homebrew (follow the directions on homebrew's homepage).
Install Libraries

.. code-block:: ring

	brew install unixodbc mysql-connector-c allegro openssl homebrew/versions/qt55
	brew link --force qt55

Build Ring (Compiler/VM)

.. code-block:: ring

	cd ring/src
	./buildclangcomplete.sh

Generate RingAllegro Source Code and Build

.. code-block:: ring

	cd ../extensions/ringallegro
	./gencode.sh
	./buildclang.sh

Generate RingLibCurl Source Code and Build

.. code-block:: ring

	cd ../extensions/ringcurl
	./gencode.sh
	./buildclang.sh


Generate RingQt Source Code and Build

.. code-block:: ring

	cd ../ringqt
	./gencode.sh
	./buildclang.sh

To be able to call ring from any folder

.. code-block:: ring

	cd ../../bin
	sudo ./install.sh

Run Ring Notepad

.. code-block:: ring

	cd applications/rnote
	sudo ring rnote.ring

.. index:: 
	pair: Building From Source Code; Building using CMake

Building using CMake
====================

Install libraries (MySQL Client, OpenSSL, LibCurl, Allegro 5 and Qt 5.5)

.. code-block:: ring

	cmake .
	make