=============================================================
README / Sofia-SIP - RFC3261 compliant SIP User-Agent library
=============================================================

Introduction
------------

Sofia-SIP is an open-source SIP User-Agent library, compliant
with the IETF RFC3261 specification. It can be used as
a building block for SIP client software for uses such as VoIP,
IM, and many other real-time and person-to-person communication
services. The primary target platform for Sofia-SIP is
GNU/Linux. Sofia-SIP is based on a SIP stack developed at
the Nokia Research Center. Sofia-SIP is licensed under the LGPL.


Quick start
-----------

Sofia-SIP uses the GNU autotools, so building procedure
is the usual:

sh> sh autogen.sh (if building from darcs)
sh> ./configure
sh> make
sh> make install

See also 'docs/devel_platform_notes.txt' for notes on compiling
Sofia-SIP in different environments.

See the "options-client-example" (available using darcs at
http://sofia-sip.org/repos/options-client-example/ or with CVS as
a module in Sofia-SIP CVS tree) for an example of a small app that
is utilizing Sofia-SIP, and specifically the libsofia-sip-ua
library component.

There are also multiple example clients under
the "sofia-sip/utils" directory:

- sip-options, query using SIP OPTIONS method
- sip-date, SIP date printer/parser

The Sofia-SIP su submodule also provides some small utilities:

- addrinfo (libsofia-sip-ua/su), resolve host names
- localinfo (libsofia-sip-ua/su), prints information about
  local network interfaces

References
----------

Project website:
- http://sofia-sip.sourceforge.net
- http://www.sourceforge.net/projects/sofia-sip

Mailing list:
- http://sourceforge.net/mail/?group_id=143636

Version control repositories:
- see the project website (link above)

Licensing
---------

Sofia-SIP is licensed under terms of the GNU LGPL.
See the file "COPYING" for more information.

===============================================================
README.developers - Sofia-SIP development practices
===============================================================

Introduction
============

This file is a collection of practices and rules for Sofia-SIP
development. If you have questions, or would like to make
changes, raise the issue on sofia-sip-devel (see
http://lists.sourceforge.net/lists/listinfo/sofia-sip-devel ).


Important files for developers
==============================

AUTHORS
	List of contributors. When contributing new code, add
	yourself to AUTHORS, and also remember to update the
	per source file copyright statements.

COPYRIGHTS
	List of licenses and related copyright statements. While
	majority of Sofia-SIP is licensed under LGPL, there are
	a few files with different, but LGPL compatible, licensing
	terms.

README.developers
	This file.

TODO
	Not in active use yet.

<dir>/ChangeLog files
	All non-trivial changes to the source code should
	be documented in the ChangeLog files. See also the
	top-level ChangeLog.


Version numbering
=================

Package version
---------------

For public releases, the package version is:
     vMAJOR.MINOR.REVISION, where MINOR is even

For development releases and snaphots the version is one of:
     vMAJOR.MINOR.REVISION, where minor is odd
     vMAJOR.MINOR.REVISION.YEAR.MONTH.DAY, where minor is odd

For all releases, the version should be changed in configure.ac
and committed to Darcs/CVS before making the release package. The person
doing the release is responsible for updating the version number.

Library interface versions
--------------------------

Sofia-SIP libraries utilize libtool interface versioning. See

  - http://www.gnu.org/software/libtool/manual.html#Versioning
  - http://www.gnu.org/software/libtool/manual.html#Using-Automake

The interface versions are set in top-level 'configure.ac' file.
Additionally, the SONAME version (CURRENT-AGE) is set in the
same place. These version numbers are available for use as autoconf
variables (see the library 'Makefile.am' files and
'packages/sofia-sip.spec.in').

All changes to the library versions should be marked to the
appropriate library 'ChangeLog' file. The library version should
be changed at the same time as the first interface change is
committed since the previous release. The interface version is
frozen (should be marked to the 'ChangeLog' file) at the time
the next release is tagged (in other words, intra-release changes
need not be tracked with libtool versions).

The goal should always be to avoid breaking the API/ABIs until
absolutely necessary. Interfaces clearly marked as private can
be changed without change to library interface version, but
otherwise all public functions, types, variables and definitions
fall under interface change control.


Version control tags
====================

Tagging releases and snapshots
------------------------------

- source repository (*)
    - master Darcs tree at:
      http://sofia-sip.org/repos/sofia-sip
    - CVS tree (only used to track major releases) at:
      http://sourceforge.net/cvs/?group_id=143636
- tags: rel-sofia-sip-x_y_z
    - stable and development releases (matches release
      version sofia-sip-x.y.z)
- tags: snapshot_rel_YEARMMDD
    - snapshot releases at
      http://sofia-sip.sourceforge.net/snapshots/

Notes (*):
    - Information about Darcs:
      http://abridgegame.org/darcs/
      http://lwn.net/Articles/110516/


Sending patches
===============

People without Darcs access
---------------------------

Send your patches to sofia-sip-devel. Someone from the
development team (see AUTHORS) will handle the patch.

People with Darcs access
------------------------

Trivial changes can be committed without review. For non-trivial
changes, you should first send a proposal to sofia-sip-devel and
wait for comments. There are no strict approval rules so use of
common sense is recommended. ;)

Tips for making patches
-----------------------

- test your patch on a clean checkout from version control system
- remember to check for updates before pushing your changes
  to the master repository