Difference between revisions of "Protege5DevDocs"

From Protege Wiki
Jump to: navigation, search
Line 5: Line 5:
  
 
''Please note that version 5.0 is currently under development.''  We occasionally post [http://protege.stanford.edu/download/protege/5.0/snapshots/ snapshot builds] for the purposes of testing, but there is currently no official release available from the [http://protege.stanford.edu/products.php#desktop-protege download page] on the main Protege website.
 
''Please note that version 5.0 is currently under development.''  We occasionally post [http://protege.stanford.edu/download/protege/5.0/snapshots/ snapshot builds] for the purposes of testing, but there is currently no official release available from the [http://protege.stanford.edu/products.php#desktop-protege download page] on the main Protege website.
 +
 +
 +
=== Accessing source code ===
 +
Protege Desktop is open source and the code is freely [http://github.com/protegeproject/protege available] on GitHub.  Use the following Git command to get a local copy:
 +
 +
<pre>
 +
git clone https://github.com/protegeproject/protege.git protege
 +
</pre>
 +
 +
The source code for many Protege Desktop plug-ins has also been made available on GitHub under the [https://github.com/protegeproject Protege Project organization].
  
  
Line 12: Line 22:
 
To follow this step-by-step guide, you must have [http://maven.apache.org/ Maven] and [http://git-scm.com/ Git] installed.
 
To follow this step-by-step guide, you must have [http://maven.apache.org/ Maven] and [http://git-scm.com/ Git] installed.
  
* Checkout the Protege Desktop source code, i.e., "git clone https://github.com/protegeproject/protege.git protege".
+
* Get a copy of the Protege Desktop source code, i.e., "git clone https://github.com/protegeproject/protege.git protege".
 
* Change into the protege directory.
 
* Change into the protege directory.
 
* Type mvn clean install.
 
* Type mvn clean install.

Revision as of 14:39, April 28, 2014


Protege Desktop 5.x Developer Documentation

This page is a top-level entry point for all developer documentation related to the Protege Desktop application, versions 5.0 and above.

Please note that version 5.0 is currently under development. We occasionally post snapshot builds for the purposes of testing, but there is currently no official release available from the download page on the main Protege website.


Accessing source code

Protege Desktop is open source and the code is freely available on GitHub. Use the following Git command to get a local copy:

git clone https://github.com/protegeproject/protege.git protege

The source code for many Protege Desktop plug-ins has also been made available on GitHub under the Protege Project organization.


Building from source

Details the steps necessary to download the Protege Desktop source code, and build a distribution from those sources.

To follow this step-by-step guide, you must have Maven and Git installed.

Once the build completes, a usable Protege Desktop installation will have been created in:

protege/protege-distribution/target/protege-distribution-${version}-bin/Protege

Use the run.bat or run.sh scripts to launch Protege Desktop.


Building with Eclipse and other IDEs

We would welcome contributions from the community for setting up development environments other than Eclipse.


Client-server