Adjust READMEs for LADI project
This commit is contained in:
parent
002b08d664
commit
5d80c77b0b
3
README
3
README
|
|
@ -1,3 +0,0 @@
|
|||
Welcome to JACK, the Jack Audio Connection Kit.
|
||||
|
||||
Please see the website (http://jackaudio.org/) for more information.
|
||||
|
|
@ -9,19 +9,18 @@ What is this?
|
|||
-----------------------------------------------------------------------
|
||||
|
||||
This file is a collection of practices and rules for JACK
|
||||
development. If you have questions, or would like to make
|
||||
changes, raise the issue on jackit-devel (see
|
||||
http://lists.sourceforge.net/lists/listinfo/jackit-devel ).
|
||||
development under LADI project.
|
||||
|
||||
For LADI specific issues, submit issues or pull request to LADI project.
|
||||
For related discussions, you are invited to join
|
||||
`Libera.Chat <https://libera.chat/>`_ channel #ladi
|
||||
|
||||
Contents
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
- What is this?
|
||||
- Version numbers
|
||||
- Important files for developers
|
||||
- Sending patches
|
||||
- CVS Access
|
||||
- Version numbers
|
||||
- Decision Process
|
||||
|
||||
|
||||
|
|
@ -31,7 +30,7 @@ Important files for developers
|
|||
AUTHORS
|
||||
List of contributors. If you have contributed code, mail Paul
|
||||
Davis to get your name added to the list, or if you have
|
||||
CVS-access, help yourself. :) Also remember to update the
|
||||
GIT-access, help yourself. :) Also remember to update the
|
||||
per source file copyright statements when committing changes.
|
||||
|
||||
README.developers
|
||||
|
|
@ -39,11 +38,11 @@ README.developers
|
|||
|
||||
TODO
|
||||
A one file mini-bugzilla for JACK developers. Note: this file
|
||||
is no longer actively updated - please use the Mantis
|
||||
bugtracker instead, see http://jackit.sourceforge.net/dev/ .
|
||||
is no longer actively updated - use the github issue tracker instead.
|
||||
|
||||
libjack/ChangeLog
|
||||
A list of _all_ changes to the public interface!
|
||||
A list of _all_ changes to the public interface! Note: this file
|
||||
is not updated since 2005 - use the git history instead.
|
||||
|
||||
|
||||
Version numbers
|
||||
|
|
@ -55,10 +54,10 @@ JACK's package version
|
|||
JACK's package version is set in configure.in, and consists of
|
||||
major, minor and revision numbers. This version should be
|
||||
updated whenever a non-trivial set of changes is committed
|
||||
to CVS:
|
||||
to GIT and packaged downstream:
|
||||
|
||||
major version
|
||||
ask on jackit-devel :)
|
||||
ask in #ladi :)
|
||||
|
||||
minor version
|
||||
incremented when any of the public or internal
|
||||
|
|
@ -74,9 +73,9 @@ Client API versioning
|
|||
JACK clients are affected by two interfaces, the JACK Client API (libjack)
|
||||
and the JACK Client Protocol API (interface between jackd and
|
||||
libjack). The former one is versioned using libtool interface
|
||||
versioniong (set in configure.in). This version should be updated
|
||||
whenever a set of changes affecting the interface is committed
|
||||
to CVS:
|
||||
versioniong (set in configure.in). This version should be
|
||||
updated whenever a non-trivial set of changes is committed
|
||||
to GIT and packaged downstream:
|
||||
|
||||
current
|
||||
incremented whenever the public libjack API is changed
|
||||
|
|
@ -88,9 +87,11 @@ age
|
|||
current libjack is both source and binary compatible with
|
||||
libjack interfaces current,current-1,...,current-age
|
||||
|
||||
Note! It was decided in January 2003 that current interface number
|
||||
Note! It was decided by original jackaudio authors in January 2003
|
||||
that current interface number
|
||||
will remain as zero until the first stable JACK version
|
||||
is released.
|
||||
In LADI jack1 version line, the first stable version is 1.121.4
|
||||
|
||||
JACK Client Protocol is versioned... <TBD>.
|
||||
|
||||
|
|
@ -102,35 +103,6 @@ in jack/libjack/ChangeLog using the standard ChangeLog style
|
|||
Sending patches
|
||||
---------------------------------------------------------------------
|
||||
|
||||
People without CVS-access
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Send your patches to jackit-devel. Normally patches are accepted
|
||||
by Paul Davis and/or Jack O'Quin. Either the patch is applied right
|
||||
away, or you get an "ok to me" message, after which other developers
|
||||
with CVS-access can commit the patch.
|
||||
|
||||
People with CVS-access
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Trivial changes can be committed without review. For non-trivial
|
||||
changes, you should first send a proposal to jackit-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 CVS-checkout
|
||||
- remember to run cvs update before making commits
|
||||
|
||||
|
||||
CVS Access
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
Contact Paul Davis.
|
||||
|
||||
|
||||
Uses of external libraries and other packages
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
|
|
@ -142,12 +114,3 @@ a configure switch for example).
|
|||
Other components like example clients and drivers, may rely on other
|
||||
packages, but these dependencies should not affect the main build
|
||||
process.
|
||||
|
||||
|
||||
Decision Process
|
||||
-----------------------------------------------------------------------
|
||||
|
||||
All non-trivial changes should be discussed on the jackit-devel
|
||||
mailing list. It has been agreed that Paul Davis will make
|
||||
the final decisions based on these discussions.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,11 @@
|
|||
Welcome to JACK, the Jack Audio Connection Kit.
|
||||
|
||||
This is a variant of `jackaudio.org JACK1 <https://github.com/jackaudio/jack1/>`_
|
||||
codebase for use with `LADI/ladish <https://github.com/LADI/ladish>`_ and
|
||||
other `LADI <https://github.com/LADI/>`_ related stuff.
|
||||
|
||||
For LADI specific issues, submit issues or pull request to LADI project.
|
||||
For related discussions, you are invited to join
|
||||
`Libera.Chat <https://libera.chat/>`_ channel #ladi
|
||||
|
||||
Do not submit LADI specific issues to jackaudio project.
|
||||
Loading…
Reference in New Issue