-
Notifications
You must be signed in to change notification settings - Fork 86
Portable development environment
In order to develop Huggle on Windows, you need to download massive amount of 3rd party libraries as well as Visual Studio community edition 2015. Therefore, having a VirtualBox with Linux that has everything, including IDE preinstalled and preconfigured, so that student can just download it, and run in VirtualBox and start working on Huggle straight away, is probably easier option for them.
A portable VirtualBox image of Ubuntu, that is completely prepared for Huggle development, has been created. New developers who struggle to set up their development environment will be able to compile Huggle and to start contributing (which really is hard when you can't compile it).
Because both MacOS and Windows are proprietary it's been decided to use Linux. This image contain preinstalled Ubuntu, stripped of unneeded stuff, which has all that you need in order to develop Huggle. The target image is ~3GB of size.
So, if you are having troubles setting up the environment to build Huggle, you can instead download our preinstalled VM with Ubuntu that is preconfigured for Huggle development.
This way you can jump into development really fast.
You can download the VM image from one of these links
- http://petr.insw.cz/huggle/huggle.ova - recommended (EU)
- http://download.wmflabs.org/huggle.ova - obsolete (alternate) (USA)
The image has about 3GB in size.
You need a VirtualBox in order to launch this, you can download it for free here: https://www.virtualbox.org/
Once it's installed, just click File -> Import appliance and import the .ova file, then you can start the VM. Once the VM is booted up, you can simply just start the QtCreator (in side bar) and Huggle will be in list of lasts open projects.
Clicking it will open an IDE which is ready to compile and run Huggle.
First of all, fork this Huggle repository. Logged into GitHub, just press Fork on the to right of the repository page.
Once you have it forked on your GitHub profile, then you can use git to create a new branch and upload it to your fork. There is git preinstalled in Huggle VM, so all you need to do is open a terminal (it's in side bar) and navigate to Huggle repository (use these commands):
# Make a backup
cp -r ~/Documents/huggle3-qt-lx ~/Documents/backup_`date +%Y%m%d%H%M%S`
cd ~/Documents/huggle3-qt-lx
# Now, this will open a simple to use editor
gedit .git/config
In text editor, replace this part of text:
[remote "origin"]
url = https://github.com/huggle/huggle3-qt-lx
With this, where obviously username is yours ;)
[remote "origin"]
url = https://github.com/<your username>/huggle3-qt-lx
Then execute these commands:
# Set up git first, don't forget to change these values
git config --global user.name "Your username"
git config --global user.email "your@email"
git checkout -b short_name_of_your_change
# If you know how to use git, just add all files you changed, otherwise do:
git commit -a -m "Short description of your change"
git push origin short_name_of_your_change
That should send the branch to your fork of Huggle's repo, then if you open it on GitHub, you should see Send a pull request button, just press it, and we will be able to review your change. Don't forget to add a explanation of your change, and a link to the task on phabricator if it exists.