getting_source.rst 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. .. _doc_getting_source:
  2. Getting the source
  3. ==================
  4. .. highlight:: shell
  5. Downloading the Godot source code
  6. ---------------------------------
  7. Before :ref:`getting into the SCons build system <doc_introduction_to_the_buildsystem>`
  8. and compiling Godot, you need to actually download the Godot source code.
  9. The source code is available on `GitHub <https://github.com/godotengine/godot>`__
  10. and while you can manually download it via the website, in general you want to
  11. do it via the ``git`` version control system.
  12. If you are compiling in order to make contributions or pull requests, you should
  13. follow the instructions from the :ref:`Pull Request workflow <doc_pr_workflow>`.
  14. If you don't know much about ``git`` yet, there are a great number of
  15. `tutorials <https://git-scm.com/book>`__ available on various websites.
  16. In general, you need to install ``git`` and/or one of the various GUI clients.
  17. Afterwards, to get the latest development version of the Godot source code
  18. (the unstable ``master`` branch), you can use ``git clone``.
  19. If you are using the ``git`` command line client, this is done by entering
  20. the following in a terminal:
  21. ::
  22. git clone https://github.com/godotengine/godot.git
  23. For any stable release, visit the `release page <https://github.com/godotengine/godot/releases>`__
  24. and click on the link for the release you want.
  25. You can then download and extract the source from the download link on the page.
  26. There are also generally branches besides ``master`` for each major version.
  27. After downloading the Godot source code,
  28. you can :ref:`continue to compiling Godot <doc_introduction_to_the_buildsystem>`.