Skip to content
Snippets Groups Projects
Commit 6a3a114e authored by gnaegi's avatar gnaegi
Browse files

OO-13 improve install readme, license, copyright

parent 42b435b8
No related branches found
No related tags found
No related merge requests found
......@@ -5,7 +5,7 @@ Please refer to the HTML documentation available at http://www.openolat.org
2. Licensing
----------------------
With regard to licensing please refer to the file LICENSE.TXT and NOTICE.TXT
With regard to licensing and copyright please refer to the file LICENSE.TXT and NOTICE.TXT
3. Contact information
......@@ -13,7 +13,7 @@ With regard to licensing please refer to the file LICENSE.TXT and NOTICE.TXT
You are welcome to participate in our development. If you make any patches to
the code, please let us know on your mailing list.
For further information about OLAT please visit the product's website at
For further information about OpenOLAT please visit the product's website at
http://www.openolat.org
......
......@@ -3,7 +3,6 @@ Setting up latest OpenOLAT version on Eclipse
o As the latest development is often ahead of the current documentation you will always find an up to date
install guide here.
o There a two different arts to install a development environment for OpenOLAT. Choose the one you prefer.
*******************************************************************************************
......@@ -22,16 +21,16 @@ Preconditions:
2. In Terminal: create eclipse project settings and create .classpath file by running
mvn eclipse:clean eclipse:eclipse
3. In Eclipse: refresh the project
3. In Eclipse: refresh the project.
3.1 Make sure the project compiled without errors. Warnings are ok.
3.2 If the project did not compile you have to fix the problems before you proceed. E.g. disable XML/XSLT validating.
Run 'mvn eclipse:clean eclipse:eclipse' again, refresh and then clean the project to recompile.
4. Create an olat.local.properties file somewhere
4.1 Copy the olat.local.properties.sample to olat.local.properties in the project root folder
4.2 Adjust the file to match your setup. See the comments in the file header for more configuration options.
4.3 Right click on the file src/main/java/olat.local.properties in our eclipse project to open the file
properties and link it to your own olat.local.properties you created in step 4.1.
4.4 Right now the same has to be done for the src/test/java/olat.local.properties: link it to a properties
file, otherwise the project will not build. Use an empty properties file if you don't want to run the
tests.
5. Prepare database permissions and initialize the database
5.1.a. In MySQL create a user 'openolat' and a database 'openolat'
......@@ -41,10 +40,11 @@ Preconditions:
FLUSH PRIVILEGES;
5.1.b. Alternatively you can use a helper script to create the MySQL database user and the empty database:
scripts/dbAndUserSetup.sh
5.2 Write the OpenOLAT database schema to the OpenOLAT database
5.1.c. Postgres users please check their Postregs manual how to create a user and database
5.2 Write the OpenOLAT database schema to the OpenOLAT database. Example for MySQL:
mysql -u openolat -p openolat < src/main/resources/database/mysql/setupDatabase.sql
5.3 Optional: if you want to run the jUnit tests, make sure you also create and initialize the test database
that you configured in src/test/java/olat.local.properties
that you configured in src/test/profile/mysql/olat.eclipse.properties
6. In Eclipse: setup tomcat server by clicking on olat->Run As->"Run on Server".
6.1 The Run on Server wizard will pop up and check: manually define a new server
......@@ -83,6 +83,10 @@ F. If you run into problems with classes or resources not found e.g. "ClassNotFo
from eclipse to console and back with command like mvn clean, or eclipse clean and such. You will always get
a clean and working environment when you do the following: Eclipse clean, create eclipse settings with launch,
Server publish resources and restart OLAT.
G. In some eclipse setups you will get compile errors because of XML/XSLT validation errors. In this case disable all
validators in the project properties (Right click on project -> "Properties" -> "Validators". After this step restart
eclipse and execute 'mvn eclipse:clean eclipse:eclipse' again, refresh and then clean the project to recompile.
Background (optional for further interest)
......
......@@ -188,7 +188,7 @@ on OLAT, please see http://www.olat.org.
Additional license statement for the openolat.org code base:
This software consists of contributions made by many members of the
OpenOLAT open source community. OpenOLAT is founded by frentix GmbH and
OpenOLAT open source community. OpenOLAT is initiated by frentix GmbH and
is initially based on the OLAT 7.1 release. For more information on
OpenOLAT, please see http://www.openolat.org
......
......@@ -11,20 +11,13 @@ along with this release. You may also obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Copyright openolat.org codebase 2011 - 2012:
Copyright openolat.org codebase since 2011:
======================================================================
OpenOLAT is © by frentix GmbH [http://www.frentix.com], Zurich, Switzerland on behalf of of the
OpenOLAT open source community [http://www.openolat.org].
OpenOLAT is initiated by frentix GmbH [http://www.frentix.com], Zurich, Switzerland and contains code
contributed by other OpenOLAT open source community members [http://www.openolat.org]. All contributed code
is copyrighted by their respective party and released under the Apache 2.0 License.
OpenOLAT logo and icons
-----------------------------------------------------------------------
The OpenOLAT logo and icons if not covered by another licenses mentioned below are released under
the Creative Commons Attribution-NoDerivs 2.5 license.
German license text [http://creativecommons.org/licenses/by-nd/2.5/ch/]
English license text [http://creativecommons.org/licenses/by-nd/2.5/]
Contributors openolat.org codebase 2011 - 2012: (in alphabetical order)
Contributors and copy right holders of openolat.org codebase since 2011:
-----------------------------------------------------------------------
- frentix GmbH, Switzerland [http://www.frentix.com]
Michael Enz, Christian Franck, Florian Gnägi, Roman Haag, Stefan Köber, Joël Krähemann,
......@@ -32,8 +25,15 @@ Contributors openolat.org codebase 2011 - 2012: (in alphabetical order)
- BPS Bildungsportal Sachsen GmbH, Germany [http://www.bildungsportal.sachsen.de]:
Armin Blawitzki, Stefan Köber, Sven Morgener
OpenOLAT logo and icons
-----------------------------------------------------------------------
The OpenOLAT logo and icons if not covered by another licenses mentioned below are released under
the Creative Commons Attribution-NoDerivs 2.5 license.
German license text [http://creativecommons.org/licenses/by-nd/2.5/ch/]
English license text [http://creativecommons.org/licenses/by-nd/2.5/]
Copyright olat.org codebase 1999 - 2011: (in alphabetical order)
Copyright olat.org codebase 1999 - 2011:
======================================================================
Björn Adelberg, Sandra Arnold, Sandra Bischof, Armin Blawitzki, Hanspeter Brun, Patrick Brunner,
Gabriel Bucher, Lavinia Dumitrescu, Lars Eberle, Stefan Egli, Claudia Ehrle, Joël Fisler, Florian Gnägi,
......
......@@ -20,20 +20,13 @@
<p>
<h4>$r.translate("about.copyright")</h4>
<pre>
Copyright openolat.org codebase 2011 - 2012:
Copyright openolat.org codebase since 2011:
======================================================================
OpenOLAT is © by frentix GmbH [http://www.frentix.com], Zurich, Switzerland on behalf of of the
OpenOLAT open source community [http://www.openolat.org].
OpenOLAT is initiated by frentix GmbH [http://www.frentix.com], Zurich, Switzerland and contains code
contributed by other OpenOLAT open source community members [http://www.openolat.org]. All contributed code
is copyrighted by their respective party and released under the Apache 2.0 License.
OpenOLAT logo and icons
-----------------------------------------------------------------------
The OpenOLAT logo and icons if not covered by another licenses mentioned below are released under
the Creative Commons Attribution-NoDerivs 2.5 license.
German license text [http://creativecommons.org/licenses/by-nd/2.5/ch/]
English license text [http://creativecommons.org/licenses/by-nd/2.5/]
Contributors openolat.org codebase 2011 - 2012: (in alphabetical order)
Contributors and copy right holders of openolat.org codebase since 2011:
-----------------------------------------------------------------------
- frentix GmbH, Switzerland [http://www.frentix.com]
Michael Enz, Christian Franck, Florian Gnägi, Roman Haag, Stefan Köber, Joël Krähemann,
......@@ -41,8 +34,15 @@ Contributors openolat.org codebase 2011 - 2012: (in alphabetical order)
- BPS Bildungsportal Sachsen GmbH, Germany [http://www.bildungsportal.sachsen.de]:
Armin Blawitzki, Stefan Köber, Sven Morgener
OpenOLAT logo and icons
-----------------------------------------------------------------------
The OpenOLAT logo and icons if not covered by another licenses mentioned below are released under
the Creative Commons Attribution-NoDerivs 2.5 license.
German license text [http://creativecommons.org/licenses/by-nd/2.5/ch/]
English license text [http://creativecommons.org/licenses/by-nd/2.5/]
Copyright olat.org codebase 1999 - 2011: (in alphabetical order)
Copyright olat.org codebase 1999 - 2011:
======================================================================
Björn Adelberg, Sandra Arnold, Sandra Bischof, Armin Blawitzki, Hanspeter Brun, Patrick Brunner,
Gabriel Bucher, Lavinia Dumitrescu, Lars Eberle, Stefan Egli, Claudia Ehrle, Joël Fisler, Florian Gnägi,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment