Accessing the source code: Difference between revisions
From LimeSurvey Manual
No edit summary |
mNo edit summary |
||
| (14 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__TOC__ | __TOC__ | ||
| Line 6: | Line 5: | ||
Until recently we used Subversion as versioning control system but now have [[Switch from Subversion to Git|moved to Git.]] | Until recently we used Subversion as versioning control system but now have [[Switch from Subversion to Git|moved to Git.]] | ||
=Accessing the LimeSurvey | =Accessing the LimeSurvey source code= | ||
Always be aware that most of the LimeSurvey Source code is '''bleeding edge'''. Do not use it for production purposes (except fo the master branch! | Always be aware that most of the LimeSurvey Source code is '''bleeding edge'''. Do not use it for production purposes (except fo the master branch! | ||
| Line 14: | Line 13: | ||
Access the LimeSurvey source code with a Subversion client for your operating system. | Access the LimeSurvey source code with a Subversion client for your operating system. | ||
*For Windows we recommend: [http://www.syntevo.com/smartgit/download.html SmartGit] because it is very easy to use. | *For Windows we recommend: [http://www.syntevo.com/smartgit/download.html SmartGit] because it is very easy to use. | ||
*For Linux | *For Linux & Mac we recommend: [http://git-scm.com/ Git]. Commandline , or use git gui, very easy too. | ||
==Step-by-Step How-To (Windows)== | ==Step-by-Step How-To (Windows)== | ||
# Create a [https://github.com/ GitHub] account. | # Create a [https://github.com/ GitHub] account. | ||
# Download and install Git for Windows from [http://code.google.com/p/msysgit/downloads/list]. Make sure that during install when asked for adding the Git path to your system path that you choose the "Run Git from the Windows Command Prompt" option. | # Download and install Git for Windows from [http://code.google.com/p/msysgit/downloads/list]. Make sure that during install when asked for adding the Git path to your system path that you choose the "Run Git from the Windows Command Prompt" option. For further help see [http://help.github.com/win-set-up-git/ Set Up Git] | ||
# Download and install [http://www.syntevo.com/smartgit/download.html SmartGit]. | # Download and install [http://www.syntevo.com/smartgit/download.html SmartGit]. | ||
# Clone the LimeSurvey repository | # Clone the LimeSurvey repository with SmartGit. You can find the right clone URL at https://github.com/LimeSurvey/LimeSurvey . | ||
# The whole source code repository should be downloading now. | # The whole source code repository should be downloading now. | ||
# By default you should see the 'master' branch in the current directory | # By default you should see the 'master' branch in the current directory | ||
# Use the Switch command from the SmartGit GUI to switch to the branch you need. | # Use the Switch command from the SmartGit GUI to switch to the branch you need. | ||
# That's it. | # That's it. | ||
==Step-by-Step How-To (Linux)== | |||
=== Read-only mode=== | |||
# Install via yum/apt/yahourt/... git and git-core | |||
# Clone LimeSurvey in ReadOnly mode : <syntaxhighlight lang="bash" >git clone git://github.com/LimeSurvey/LimeSurvey.git</syntaxhighlight> | |||
# By default you should see the 'master' branch in the current directory | |||
# To set to dev (Yii branch actually)<syntaxhighlight lang="bash" >cd LimeSurvey | |||
git checkout Yii</syntaxhighlight> | |||
# To get the update from LimeSurvey:<syntaxhighlight lang="bash" >cd LimeSurvey | |||
git pull</syntaxhighlight> | |||
=== Start your own branch ( Fork )=== | |||
# See the complete instrtuction in GitHub : http://help.github.com/fork-a-repo/ | |||
Please add instructions for other OSs or complete the existing ones. | Please add instructions for other OSs or complete the existing ones. | ||
| Line 31: | Line 46: | ||
These are the available GitHub branches right now: | These are the available GitHub branches right now: | ||
*master - This is | *master - This is always the current stable (plus) version including any fixes not yet released. | ||
*original_art and original_art 2: These are the SVG files for almost all icons the stable and Yii version. | *original_art and original_art 2: These are the SVG files for almost all icons the stable and Yii version. | ||
*other_scripts, server_scripts, translation status: These are scripts being used in limesurvey.org or for new releases. We will merge these to a single 'server-scripts' branch soon. | *other_scripts, server_scripts, translation status: These are scripts being used in limesurvey.org or for new releases. We will merge these to a single 'server-scripts' branch soon. | ||
=Further documentation= | =Further documentation= | ||
Please make sure you code accoding to our [[Coding guidelines]]. | Please make sure you code accoding to our [[Coding guidelines]]. | ||
Latest revision as of 14:55, 16 February 2022
General
Until recently we used Subversion as versioning control system but now have moved to Git.
Accessing the LimeSurvey source code
Always be aware that most of the LimeSurvey Source code is bleeding edge. Do not use it for production purposes (except fo the master branch!
As for many other free software projects only community support is available.
Access the LimeSurvey source code with a Subversion client for your operating system.
- For Windows we recommend: SmartGit because it is very easy to use.
- For Linux & Mac we recommend: Git. Commandline , or use git gui, very easy too.
Step-by-Step How-To (Windows)
- Create a GitHub account.
- Download and install Git for Windows from [1]. Make sure that during install when asked for adding the Git path to your system path that you choose the "Run Git from the Windows Command Prompt" option. For further help see Set Up Git
- Download and install SmartGit.
- Clone the LimeSurvey repository with SmartGit. You can find the right clone URL at https://github.com/LimeSurvey/LimeSurvey .
- The whole source code repository should be downloading now.
- By default you should see the 'master' branch in the current directory
- Use the Switch command from the SmartGit GUI to switch to the branch you need.
- That's it.
Step-by-Step How-To (Linux)
Read-only mode
- Install via yum/apt/yahourt/... git and git-core
- Clone LimeSurvey in ReadOnly mode :
git clone git://github.com/LimeSurvey/LimeSurvey.git
- By default you should see the 'master' branch in the current directory
- To set to dev (Yii branch actually)
cd LimeSurvey git checkout Yii
- To get the update from LimeSurvey:
cd LimeSurvey git pull
Start your own branch ( Fork )
- See the complete instrtuction in GitHub : http://help.github.com/fork-a-repo/
Please add instructions for other OSs or complete the existing ones.
Available branches
These are the available GitHub branches right now:
- master - This is always the current stable (plus) version including any fixes not yet released.
- original_art and original_art 2: These are the SVG files for almost all icons the stable and Yii version.
- other_scripts, server_scripts, translation status: These are scripts being used in limesurvey.org or for new releases. We will merge these to a single 'server-scripts' branch soon.
Further documentation
Please make sure you code accoding to our Coding guidelines.