-
-
Notifications
You must be signed in to change notification settings - Fork 19
Environment Setup
This page is about setting up your environment to run and make changes to the development version of Scelight locally on your computer. To contribute to the Scelight project, you should first read the Way of Contributions page.
Eclipse is the recommended IDE for developing Scelight as I provide Eclipse configuration, code templates and format styles. You may use other IDEs too if you wish so, but I give no support for them.
Once you have a Scelight clone in your computer, you can import it as an existing project into Eclispe.
In Eclipse, right click on the project => Properties -> Java Code Style => Code Templates. Import the eclipse/Icza-codetemplates.xml
file.
In Eclipse, right click on the project => Properties -> Java Code Style => Formatter. Import the eclipse/Icza-format-style.xml
file.
Note that you should always format your code (e.g. CTRL+F to format current file) according to the formatting rules defined in eclipse/Icza-format-style.xml
.
Also note that the Scelight project has strict rules about javadocs. You can view these in Properties => Java compiler => Javadoc. For example it will result in compile-time errors if
- javadoc is missing (even for
private
tags) - the javadoc is malformed