Skip to content
Permalink
Browse files

Work on legalese.

  • Loading branch information
sfermigier committed Dec 22, 2014
1 parent 11998d3 commit c63bb850dcac5a306a2b87588568cbb95e51ce56
Showing with 112 additions and 94 deletions.
  1. +22 −0 CONTRIBUTORS.md
  2. +0 −13 CONTRIBUTORS.txt
  3. +5 −2 LICENSE.txt
  4. +73 −66 README.md
  5. +12 −13 TRADEMARK_CLAUSE.txt → TRADEMARK_CLAUSE.md
@@ -0,0 +1,22 @@
The CORPORATE SPONSORS:

- Sopinspace SARL
- Abilian SAS <https://www.abilian.com/>


The PRIMARY AUTHORS are (and/or have been):

- Renaud Bernard (renaud.bernard@sopinspace.com)
- Raphaël Badin (raphael.badin@sopinspace.com)
- Gérald Sedrati-Dinet (gsd@sopinspace.com)
- Simon Descarpentries (sid@sopinspace.com)
- Stefane Ferigier (sf@abilian.com)
- Bertrand Mathieu (bmathieu@abilian.com)


The MUCH-APPRECIATED CONTRIBUTORS (people having submitted patches,
reported bugs, added translations):

- Kirill Miazine (<http://km.krot.org/>)
- Paulo Rená da Silva Santarém (pbrss@yahoo.com.br)
- Alejandro Martin Ortin (alejandromartinortin@gmail.com)

This file was deleted.

@@ -1,9 +1,12 @@
COMT: Web-based text annotation
Copyright (C) 2006-2010 Sopinspace, Society for Public Information Spaces, www.sopinspace.com
Key developers: Renaud Bernard, Raphaël Badin, Gérald Sédrati-Dinet, Simon Descarpentries
Copyright (C) 2006-2015 Abilian SAS <http://www.abilian.com/>
Key developers: see CONTRIBUTORS file
Software license: GNU AGPLv3 or any later version
Translation files license: CC-By


--

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License
published by the Free Software Foundation either version 3 of the
139 README.md
@@ -1,6 +1,8 @@
# Installation
# Comt, free software Web-based text annotation platform

Run:
## Installation

If you're busy, run:

git clone git@git.abilian.com:co-ment/comt.git
git clone git@git.abilian.com:co-ment/lite-co-ment-com.git lite.co-ment.com
@@ -18,22 +20,16 @@ Run:
deactivate


# Older information (needs to be checked)


## About

Comt is an free software Web-based text annotation platform.
Comt is a free software Web-based text annotation platform.

## License

GNU AFFERO GENERAL PUBLIC LICENSE
http://www.gnu.org/licenses/agpl.html
GNU AFFERO GENERAL PUBLIC LICENSE (<http://www.gnu.org/licenses/agpl.html>)
for software files

CC-BY
http://creativecommons.org/licenses/by/3.0/
for translation files
CC-BY (<http://creativecommons.org/licenses/by/3.0/>) for translation files

## Dependencies

@@ -63,64 +59,78 @@ for translation files
## Installation (development install)

1. Install python2.5+ and all required libraries
(ubuntu users : 'sudo apt-get install python python-magic python-setuptools python-uno libyaml-0-1 python-yaml python-dev git-core python-utidylib python-pexpect python-cssutils')
(ubuntu users: `sudo apt-get install python python-magic python-setuptools python-uno libyaml-0-1 python-yaml python-dev git-core python-utidylib python-pexpect python-cssutils`)

2. Install pandoc
(ubuntu users : 'sudo apt-get install pandoc')
(ubuntu users: `sudo apt-get install pandoc`)

3. Install abiword
(ubuntu users: 'sudo apt-get install abiword')
Alternatively, install openoffice (headless mode) [used for document conversion]
(ubuntu users : 'sudo apt-get install sun-java6-jre openoffice.org openoffice.org-headless xvfb')
(ubuntu users: `sudo apt-get install abiword`)
Alternatively, install openoffice (headless mode) (used for document conversion)
(ubuntu users: `sudo apt-get install sun-java6-jre openoffice.org openoffice.org-headless xvfb`)

4. Install/configure database (skip this step if you plan to use a sqlite database)

4. Install/configure database [skip this step if you plan to use a sqlite database]
4 a) Postgresql

- Install and configure database server [skip this step if use an external database server]
(ubuntu users : 'sudo apt-get install postgresql')
(ubuntu users : `sudo apt-get install postgresql`)
- Install database client
(ubuntu users : 'sudo apt-get install postgresql-client')
(ubuntu users : `sudo apt-get install postgresql-client`)
- Install python database connector: psycopg2
(ubuntu users : 'sudo apt-get install python-psycopg2')
(ubuntu users : `sudo apt-get install python-psycopg2`)

4 b) Mysql

- Install and configure mysql server [skip this step if use an external database server]
(ubuntu users : 'sudo apt-get install mysql-server')
(ubuntu users : `sudo apt-get install mysql-server`)
- Install database client
(ubuntu users : 'sudo apt-get install mysql-client')
(ubuntu users : `sudo apt-get install mysql-client`)
- Install python database connector: mysqldb
(ubuntu users : 'sudo apt-get install python-mysqldb')
5. Create a database (we recommend UTF8 encoding) and a read/write access to it. [skip this step if you plan to use a sqlite database]
(ubuntu users : `sudo apt-get install python-mysqldb`)

5. Create a database (we recommend UTF8 encoding) and a read/write access to it. (skip this step if you plan to use a sqlite database)

The database account accessing the database MUST have administrative privileges when running the 'syncdb command' (step 8)
(The reason for that is that Postgresql requires such privileges to create the C-based stored procedure that we use for full text indexing)
(ex. postgresql: 'sudo -u postgres createdb -E utf8 -e <db_name>)

6. Setup the project and get dependencies
- `python bootstrap.py`
- `./bin/buildout`

- `python bootstrap.py`
- `./bin/buildout`

7. Configure Comt to your settings
- copy settings_local_sample.py to settings_local.py (this file will contain your personal settings)
- edit settings_local.py to suit your settings (search for 'YOUR_SETTINGS' occurrences, those are mandatory settings)

- copy `settings_local_sample.py` to `settings_local.py` (this file will contain your personal settings)
- edit `settings_local.py` to suit your settings (search for `YOUR_SETTINGS` occurrences, those are mandatory settings)

8. Create the database structure (and test your database connection)

- `./bin/django syncdb --settings=settings`
- `./bin/django migrate --settings=settings`

9. Create basic right management system

- `./bin/django loaddata roles_generic --settings=settings`

10. Launch development server

- `./bin/django runserver --settings=settings`

11. Access your Comt instance by pointing your browser to http://127.0.0.1:8000/



## Installation (production environment)

This README.txt does not cover in details a production environment because this kind of setup is too platform dependant for us to provide a guide.
This README does not cover in details a production environment because this kind of setup is too platform dependant for us to provide a guide.

A few tips thought:

- recommended way to install it is using apache and wsgi, check out django installation guide at http://www.djangoproject.com/documentation/modpython/
- if you use apache as a frontend, you will need to create {{ APACHE_HOME: usually /var/www }}/.python-eggs and chown it to apache
- The recommended way to install it is using apache and wsgi, check out django installation guide at >http://www.djangoproject.com/documentation/modpython/>
- If you use apache as a frontend, you will need to create `{{ APACHE_HOME: usually /var/www }}/.python-eggs` and chown it to the `apache` user.


## Upgrade

@@ -140,30 +150,32 @@ If your database was created using comt alpha prior to the revision 29, here are
- `./bin/django migrate cm 0001_initial --fake`
- `./bin/django migrate`


## Abiword or Openoffice ?

Comt uses either abiword or openoffice to convert documents from ODT, MS Word, etc. to html.

Abiword is a lighter and more performant solution. You have to add the configuration parameter `USE_ABI = True` in your settings_local.py to use Abiword. Otherwise openoffice is used.
Abiword is a lighter and more performant solution. You have to add the configuration parameter `USE_ABI = True` in your `settings_local.py` to use Abiword. Otherwise openoffice is used.

To use openoffice, on a development setup, you should make sure no openoffice process is left and launch `soffice -headless "-accept=socket,port=2002;urp;"` to start openoffice in background mode.

## Comt uses

## Libraries and assets COMT depends upon

### Javascript libs used (and license) / shipped with the distribution

- Yahoo UI http://developer.yahoo.com/yui/ BSD License
- JQuery http://jquery.com/ MIT
- markItUp http://markitup.jaysalvat.com/home/ MIT/GPL
- Yahoo UI <http://developer.yahoo.com/yui/> (BSD License)
- JQuery <http://jquery.com/> (MIT license)
- markItUp <http://markitup.jaysalvat.com/home/> (MIT/GPL license)

### Python libraries used (and license) / NOT shipped with the distribution

- django http://www.djangoproject.com/ BSD License
- python magic http://hupp.org/adam/hg/python-magic permissive BSD style license
- Beautiful soup http://www.crummy.com/software/BeautifulSoup/ PSF license
- python-chardet http://chardet.feedparser.org/ LGPL
- python-feedparser http://feedparser.org/ "Permissive" custom license
- python-imaging http://www.pythonware.com/products/pil/ http://www.pythonware.com/products/pil/license.htm
- django <http://www.djangoproject.com/> BSD License
- python magic <http://hupp.org/adam/hg/python-magic> permissive BSD style license
- Beautiful soup <http://www.crummy.com/software/BeautifulSoup/> PSF license
- python-chardet <http://chardet.feedparser.org/> LGPL
- python-feedparser <http://feedparser.org/> "Permissive" custom license
- python-imaging <http://www.pythonware.com/products/pil/> http://www.pythonware.com/products/pil/license.htm
- python-pytz
- html5lib
- python-simplejson
@@ -174,8 +186,9 @@ To use openoffice, on a development setup, you should make sure no openoffice pr
- python-cssutils

### Icons
-----
- Icons derived from FatCow Icon Set http://www.fatcow.com/free-icons/index.bml (Creative Commons Attribution 3.0 License)

Icons derived from FatCow Icon Set (<http://www.fatcow.com/free-icons/index.bml>) (Creative Commons Attribution 3.0 License)


## FAQ

@@ -202,54 +215,48 @@ Q4: I get 'import error' when starting the server (step #9)

R4: Make sure you installed all required python dependencies

## Community

The Comt web site http://www.co-ment.org is the place to ask questions, report bugs, check out the source code or download the releases of Comt.

## How to contribute

### Contribute using mercurial

We use mercurial as our source code management system.
## Community

1. Create a mercurial profile (nickname/email) in ~/.hgrc (cf. http://mercurial.selenic.com/quickstart for more info).
This is important because your name will appear in your changeset once it gets accepted into the mainline
The Comt web site <http://www.co-ment.org/> is the place to ask questions, report bugs, check out the source code or download the releases of Comt.

2. Clone the repository `hg clone http://hg.co-ment.org/ comt`
OR update your copy of the source code: `hg update`

3. Hack, hack
## How to contribute

4. Commit locally: `hg commit -m "MY COMMIT MESSAGE"`
We use GitHub as our collaboration tool.

### Reporting issues

5. Export your changeset to a file: `hg export tip > my_patch.txt`
Please use the GitHub issue tracker for the project: <>

6. Create a ticket describing your change and attach your patch to it: http://www.co-ment.org/newticket

7. We will review the patch as soon as possible. If we judge it acceptable and useful, we will be back to you regarding copyright, licensing and other legalese.
### Contribute using Git

### Contribute without using mercurial
We use Git as our source code management system.

If you don't want to use mercurial, you can also create a ticket (http://www.co-ment.org/newticket) with a few modified files to the bugtracker.
You can submit pull request

Make sure you leave us a nickname and an email for inclusion in the changelog. Point 7 above also applies to contributions without using mercurial.

## Translation

### Update all po files

Run:

cd src/cm
../../bin/django makemessages -a
../../bin/django makemessages -d djangojs -a

### Compile po files

Run:

cd src/cm
../../bin/django compilemessages

### Create new file for lang 'LG'

Run:

cd src/cm
../../bin/django makemessages -l LG -e .html,.txt
../../bin/django makemessages -d djangojs -l LG

@@ -1,27 +1,26 @@
================
Trademark clause
================

Additionnal trademark clause
============================
----------------------------

### Trademark

Trademark
---------
co-ment(R) is a registered trademark of Philippe Aigrain.

Additional trademark clause to the GNU Affero GPLv3 license for the COMT software
---------------------------------------------------------------------------------
### Additional trademark clause to the GNU Affero GPLv3 license for the COMT software

As authorized by the [GNU AGPLv3](http://www.fsf.org/licensing/licenses/agpl.html "Affero GPLv3 license text") license, users of the COMT software can only make use of the co-ment trademark in compliance with the regulation of use (see below).

Regulation of use for the co-ment(R) trademark
==============================================
----------------------------------------------

### Sopinspace

Sopinspace
----------
Sopinspace is a SARL (limited liability company) with a capital of 15000 €, registered in France under the number RCS Paris B 451 436 604 with VAT number FR92 451 436 604. Sopinspace(R) is a registered trademark. Postal address: 4, passage de la Main d'Or, F-75011 Paris, France.

Definitions
-----------
### Definitions

For the application of this regulation:

1. *Country of operation* designate the country in which an activity (such as operating a Web service or distributing software) covered by the co-ment trademark classes is conducted.
@@ -32,8 +31,8 @@ For the application of this regulation:
6. *General interest organisation* designates an organization whose main purpose is to serve the public.
7. *Sopinspace co-ment sites* designates any website operated by Sopinspace whose domain name contains *co-ment* and any subdomain of these sites.

Rules
-----
### Rules

Use of the co-ment trademark by a commercial entity or for any commercial purpose is forbidden without written authorization of the tramemark holder.

Non-for-profit organisations are welcome to make use of the co-ment trademark within source code, documentation or user interfaces for their non-for-profit activities when operating Web services or software based on the COMT platform or developing activities making use of Sopinspace's co-ment(R) Web services, provided that:

0 comments on commit c63bb85

Please sign in to comment.