| Path: | doc/README_FOR_APP |
| Last Update: | Tue Dec 30 11:20:43 +0100 2008 |
Welcome to the documentation of the code of LogiLogi Manta.
The development is in progress, expected release: soon.
What LogiLogi Manta is ? There‘s short description at: en.logilogi.org/MetaLogi/LogiLogiManta
LogiLogi Manta is Free Software and Open Source, written by the LogiLogi Foundation.
To explore the API documentation you can best start by looking at Logi and Link.
This documentation is updated automatically as we improve and extend the code.
A video of a presentation on LogiLogi can be seen here: video.google.nl/videoplay?docid=865414300290684342
Papers and presentations on LogiLogi plus their source can be checked out here:
svn co https://logilogi.svn.sourceforge.net/svnroot/logilogi/docs
Or online on the Foundation Blog
If you want to develop this innovative project with us, or discuss it, you are welcome to introduce yourself on our mailing-list
And of course you can also create an account on LogiLogi.org
First install the stable ruby version (1.8.2 or 1.8.4), mysql, libopenssl for ruby, the xapian search-lib, gettext, and subversion (for getting the code). If you are using Ubuntu or Debian as your OS see the notes at the bottom for which packages you need.
Then install Manta via the subversion installation.
(Note that LogiLogi Manta is still in pre-alpha state, and thus we have no user-releases yet)
LogiLogi Manta requires Rails and the daemons, rmagick, version 2.2.2 or more, *with svg support*, ruby-openid, mysql, gettext, rubyzip, positionrange, difflcs, textweaver and authlogic gems (version >= 1.0)
Also see the Installation Notes at the bottom.
You can install Ruby gems by downloading it from here:
http://rubyforge.org/frs/?group_id=126 (the newest) then untar with tar -xzvf rubygems*.tgz and install it with cd rubygems*; ruby setup.rb (as root)
Then you can install Rails
gem install rails (as root, if gem command is not found you might have to type gem1.8 instead)
And then the required gems
gem install daemons rmagick ruby-openid mysql gettext rubyzip authlogic (as root, same here as with Rails installation)
Then you can get Manta directly from our Subversion repository
svn co https://logilogi.svn.sourceforge.net/svnroot/logilogi/trunk
The other required plugins are imported automatically by subversion when you checkout the code.
Copy the config.rb.tmpl to config.rb in the config dir, and change settings as you see fit (usually no changes are needed, and for development no changes are recommended).
Copy the template database.yml.tmpl in the config dir to database.yml, and add your database-username and -password. Making changes is only needed if you did set a root-password for your database.
Then with rake dev:check you can test if you installed everything correctly.
To (re-)initialize the test- and development-database you should run rake db:dev:redo once.
Now you can run the unit-tests…
To get going with the GUI you should add something like the following to your /etc/hosts:
0.0.0.0 www.logi-manta.org en.logi-manta.org de.logi-manta.org
Then start the included WEBRick server with script/server
Then you can point your browser to www.logi-manta.org:3000/
You‘re all set.
If you want to do development always run rake dev:update before you start. This pulls in changes from svn and updates your config and db (overwrites them).
To build the documentation and/or the presentations you need latex (texlive & latex-beamer), tex2pdf (tex2pdf.berlios.de/) and b-rex (included in the doc‘s svn, in the b-rex dir, but also available on: en.logilogi.org/Logi_Logi/Tools/Beamer_Rex)
Then where you checked out the docs you can build the presentation- file beamer.tex:
cd b-rex; ./b-rex ../presentation/ECAP08/beamer.tex
While the handout.tex builds the handouts for most presentations.
If you are on Ubuntu you need to install the following packages to get a standard Ruby installation:
sudo apt-get install ruby ruby1.8-dev libzlib-ruby rdoc irb rake
And to get MySQL, Subversion and libopenssl, gettext and Xapian:
sudo apt-get install make mysql-server mysql-client
mysqlclient15-dev subversion libopenssl-ruby1.8 libxapian15
libxapian-ruby1.8 gettext
RMagick will build extensions from source. Don‘t forget to install librsvg2-dev, and libmagick9-dev, before installing the rmagick gem, so you have svg support for the background-images.
And if you have to install ImageMagick from source, you can do it with:
./configure —disable-openmp; make; sudo make install; sudo gem install rmagick
(incomplete)
On Xandros you need libruby1.8 and rdoc & ruby1.8-dev
If you get an error saying that Rmagick cannot open a file in /tmp, and find this: "wmf2eps: not found" in your logs, it likely is because the svg extension is not working. You will need librsvg2-dev and then re-install Rmagick.