Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
doc updates for community-led project
  • Loading branch information
dalers committed Oct 15, 2012
1 parent 19340f8 commit cd01231
Show file tree
Hide file tree
Showing 7 changed files with 4,468 additions and 486 deletions.
59 changes: 59 additions & 0 deletions README.md
@@ -0,0 +1,59 @@
ATK Framework
=============
The ATK Framework is a special purpose PHP framework targeted at business applications. It allows you to build an application with very small amounts of code.

Its focus on business features makes it an excellent framework for HRM, CRM, data management and CMS type applications. The ATK Framework is stable and suitable for production. For more information, see the [ATK Framework GitHub project wiki](https://github.com/atkphpframework/atk/wiki) and the [ATK Framework website](http://www.atk-framework.com).

The purpose of the the [ATK Framework project on GitHub](https://www.github.com/atkphpframework/atk) is to create, as a community, the leading rapid-development framework for creating enterprise web applications, such as [Achievo](https://www.github.com/atkphpframework/achievo) for enterprise resource management. The ATK Framework was created by [ibuildings.nl](http://www.ibuildings.nl) and development is now carried on by the open source community, managed by the [GitHub atkphpframework group](https://www.github.com/atkphpframework/), with the endorsement and permission of [ibuildings.nl](http://www.ibuildings.nl).

* The ATK Framework is licensed under the terms of the GNU Lessor General Public License v3. See the doc/COPYRIGHT and DOC/LICENSE files, and the [License page in the ATK Framework project wiki](https://github.com/atkphpframework/atk/wiki/License) for more information.

* The ATK Framework is a trademark of ibuildings.nl. See the [ATK Framework Trademark and Logo Policy](https://github.com/atkphpframework/atk/wiki/Trademark-and-Logo-Policy) for more information.

To Get Started
==============
Applications built using the ATK Framework can be hosted on a standard web application AMP stack (Apache/MySQL/PHP), and is compatible with current AMP stack component versions (e.g. PHP 5.4.x, MySQL 5.5.x). ATK requires PHP 5.1.3 or newer.

The most convenient way to get started using the ATK Framework is to clone the [ATK Framework GitHub repository](https://github.com/atkphpframework/atk) to your webserver. The master branch, containing the most recent production release, will be automatically checked out. Besides the master branch, the repository includes a number of previous release branches, including release-6.4 which is being maintained for Achievo (until Achievo has been migrated to the current release).

If you want to learn about the ATK Framework, an [ATK Framework demo appliation](https://www.github.com/atkphpframework/atkdemo) is available. The demo is lesson-based, with the lessons covering the basic functionality and features of ATK Framework.

Version Control and Issue Tracking
==================================
* [ATK Framework GitHub project canonical repository](https://github.com/atkphpframework/atk)
* [ATK Framework GitHub project issue tracker](https://github.com/atkphpframework/atk/issues)
* [ibuildings Achievo/ATK bugzilla](http://bugzilla.achievo.org/query.cgi) for searching historical issues prior to ATK 6.6.0 (if you find an issue that applies to the current release, please copy the pertinent details into a new GitHub issue and include a reference to the Bugzilla entry).

Communication Channels
======================
Developers using the ATK Framework discuss problems and solutions, keep each other informed, and generally help each other out, on the [Achievo/ATK forum](http://forum.achievo.org/). It's a good idea to create a free user profile on the forum, you will need it to post topics or reply to existing topics (although viewing does not require a profile). If you create a new topic, please be careful to submit it in an ATK Framework sub-forum (not an Achievo sub-forum).
* [Achievo/ATK forum](http://forum.achievo.org/)

Developer Guidelines
====================
See [Developer Guideines](https://github.com/atkphpframework/achievo/wiki/Developer-Guidelines) in the ATK Framework project wiki.

Documentation
=============
Official project documentation (although still somewhat sparse) is in the [ATK Framework GitHub project wiki](https://github.com/atkphpframework/atk/wiki/), with valuable discussion topics in the [Achievo/ATK forum](http://forum.achievo.org/). The [ATK Framework website](http://www.atk-framework.com/) is a valuable resources, as well as the [ibuildings Achievo/ATK wiki](http://www.achievo.org/wiki/)(although detailed information may not be current, updated information is published on the [ATK Framework GitHub project wiki](https://github.com/atkphpframework/atk/wiki/)). The ATK Framework is documented internally with PHPDoc comments, and the [ATK Framework API documentation](http://www.atk-framework.com/documentation/) can also be browsed on the [ATK Framework website](http://www.atk-framework.com/).

* [ATK Framework GitHub project wiki](https://github.com/atkphpframework/atk/wiki/)
* [Achievo/ATK forum](http://forum.achievo.org/)
* [ATK Framework website](http://www.atk-framework.com/)
* [ibuildings Achievo/ATK wiki](http://www.achievo.org/wiki/)

Support
=======
In the event you have a problem:

* Review ATK Framework behavior using an unaltered production-release of the [ATK Framework Demo](https://www.github.com/atkphpframework/atkdemo).
* Search the [ATK GitHub project wiki](https://github.com/atkphpframework/atk/wiki/) and the [ibuildings Achievo/ATK wiki](http://www.achievo.org/wiki/).
* Search the [Achievo/ATK forum](http://forum.achievo.org/).
* Search the [ATK GitHub project Issues](https://github.com/atkphpframework/atk/issues) and [ibuildings legacy bug tracker](http://bugzilla.achievo.org/query.cgi).
* Post a question to the [Achievo/ATK forum](http://forum.achievo.org/) (free account sign-up is required for posting). When posting to the forum, always include the following to help other Achievo users and developers give you the best response:
** a summary of what you are trying to achieve and symptoms of the problem (what you think is going wrong, or not happening when it should)
** your server operating system and version (e.g., FreeBSD 9.0, Ubunto 11.10, OpenSUSE 12.1, Windows 7, ...)
** your web server and version (e.g., Apache 2.2.22)
** your PHP version (e.g., PHP 5.3.10)
** your MySQL server version (e.g., MySQL 5.5.20)
** (optional) example code. Sometimes posting code is the simplest way to describe a technical problem you're having. If you are posting code, provide the simplest example that demonstrates your problem.
286 changes: 150 additions & 136 deletions doc/AUTHORS
@@ -1,60 +1,96 @@
Author
------
Ivo Jansch <ivo at egeniq.com>
The name by which a contributor is referred to in the doc/CHANGES file
is given in []'s (if different from their first name).

Maintainer
----------
Sandy Pleyte <sandy at achievo.org>

Additional Development
----------------------
Peter Verhage <peter at egeniq.com>
Martin Roest <martin at ibuildings.nl>
Boy Baukema <boy at ibuildings.nl>
Yury Golovnya <yury at achievo.org>

Sponsors
--------
ATK grows not only through contributions from the Open Source community,
but also through financial donations from sponsors, who finance the
development of new features.

* Ibuildings.nl BV, Netherlands (http://www.ibuildings.nl) sponsors the
development of ATK and sponsors ATK's hosting and development
facilities (site, mailinglists, cvs etc).

* Cendris BV, Netherlands (http://www.cendris.com) sponsored the development
of keyboard navigation, some parts of the oracle driver and field range
search support.

* Prosa.dk, Denmark (http://www.prosa.dk) sponsored the development of the
multi-sort and subtotals/aggregation features.

* Petrosys Pty, Australia (http://www.petrosys.com.au) sponsored the
fix for bug #269.

* For Funding BV, The Netherlands (http://www.funding.nl), we developed
the Privacy Enhancing Technologies extensions, the atkCurrencyAttribute,
the atkFormatAttribute and improvements to the CSV import feature.

* For Dataroomservices, The Netherlands (http://www.dataroomservices.nl), we
added PDA detection support.

* For Zicht Nieuwe Media Ontwerpers, The Netherlands (http://www.zicht.nl), we
added the atkShuttleRelation, enhanced the atkFckAttribute and added the
autonumbering feature to atkFileAttribute. Zicht also sponsored a large part
of the atkMlWrapper functionality.
Programmers
-----------
The following individuals have contributed code to the ATK Framework project:

* Egeniq, The Netherlands (http://www.egeniq.com) is the new company of
ATK's original author and occasionally contributes new features and
bugfixes.
Rene Bakx
Joachim N?bold
Kevin Golding
Pieter Heijmans
Soh Kok Hong
Kees van Dieren
Nicola
J.Enrique Ruiz [Ruiz]
C?sar Ordi?ana [Cesar]
Harrie Verveer
Thom Dyson
Andres Attemann
Brian Gillis
Martin Looise [MartinL]
Gabriele Gallacci
Fabrizio Vanzani
Dennis-Jan Broerse
Gustavo Espinosa Tavitas
Eldad Ran
Arnold Cano
Danny Peeters
Alberto Galanti
Bas de Nooijer
Tjeerd Bijlsma
Przemek Piotrowski
Olav B. Lygre
Renato Furter
Stefano Salvador
Roberto Berto
Nico de Boer
Klaus ?
Gabriel Achtig
Christian Hudson [ChristianH]
Ludo Beumer
Patrick van der Velden
Kevin L. Winmoe [KevinLW]
Jorge Garifuna [JorgeG]
Fabio Saitta
Jeroen van Sluijs
Bart Helms
Rainer Glaschick [RainerG]
Rich Kucera
Marlon Bilog
Michael Zaugg [MichaelZ]
Michael Anello [MichaelA]
Almer Kaasschieter
Rene van den Ouden [RenevO]
Ruud Alberts
Rik Tonnard [RikT]
Dennis Luitwieler
Edgar van Ispelen
Peter Bottenberg [PeterB]
Mark van der Velden [mvdvelden]
Rik Willems
Arjen Tebbenhof
Vito Chin
Bjorn de Haan
Erik Snoeijs
Michael Stillwell
Wim Kosten
Michele Rota
Max Westen
Lineke Kerckhoffs Willems
Maurice Maas
Alfred Armstrong
Matthieu Giroux
Matthijs van den Bos [Matthijs]
Jos Huiting [jhuiting]
Daan van Renterghem [DVR]

To become a sponsor, please contact us at http://www.ibuildings.com/contact/.
Theme Designers
---------------
The following individuals have contributed either new themes or updates
to existing themes:

'outlook' : Paul Verhoeff
'win2k' : Markus Schubert
'moronic' : Sandy Pleyte
'macoslike' : Marcel Visscher
'steelblue' : Almer Kaasschieter
'stillblue' : Peter Verhage & Eric Snoeijs

Translators
-----------
The following people contributed a translation or updated an existing one:
The following individuals have contributed either new translations or updates
to existing translations:

Arabic : Hamdi Sahloul
Braz. Portuguese: Armando M. Baratti
Expand Down Expand Up @@ -136,12 +172,32 @@ Spanish : Jorge Ibsen
Swedish : Thomas Karlsson
Turkish : Bilal Akcay



Major Contributors
------------------
We like to thank the following people especially, since they made
significant contributions to the ATK project.
The following individuals and organizations have contributed significantly
to the ATK Framework project for which we thank them.

Ibuildings

The ATK Framework was created by Ibuildings, who were responsible for
development up to version 6.6.0 (after which Ibuildings allowed the ATK
community to assume responsibility). The following Ibuildings staff are
individually recognized for their efforts.

Author
------
Ivo Jansch <ivo at egeniq.com>

Maintainer
----------
Sandy Pleyte <sandy at achievo.org>

Additional Development
----------------------
Peter Verhage <peter at egeniq.com>
Martin Roest <martin at ibuildings.nl>
Boy Baukema <boy at ibuildings.nl>
Yury Golovnya <yury at achievo.org>

Stefan Niederhauser

Expand Down Expand Up @@ -169,89 +225,47 @@ Guido van Biemen
template engine in ATK, made ATK largely notice free and fixed a significant
amount of bugs.

Sponsors
--------
The following individuals and organizations have contributed to development
of the ATK Framework through their greatly appreciated sponsorship:

If you would like to sponsor ATK Framework development, please indicate
your interest in a post to the Achievo/ATK forum
http://forum.achievo.org/ (you will need to create a free profile
first, and please post in the ATK Development Questions sub-forum).

* Ibuildings.nl BV, Netherlands (http://www.ibuildings.nl) sponsored the
creation of Achievo and the ATK Framework, and currently sponsor the ATK
website (http://www.atk-framework.com), the Achievo website
(http://www.achievo.org), and the Achievo/ATK forum
(http://forum.achievo.org). Ibuildings also host the legacy svn code
repository, bug tracker, and wiki.

* Cendris BV, Netherlands (http://www.cendris.com) sponsored the development
of keyboard navigation, some parts of the oracle driver and field range
search support.

Theme Designers
---------------
'outlook' Paul Verhoeff
'win2k' Markus Schubert
'moronic' Sandy Pleyte
'macoslike' Marcel Visscher
'steelblue' Almer Kaasschieter
'stillblue' Peter Verhage & Eric Snoeijs
* Prosa.dk, Denmark (http://www.prosa.dk) sponsored the development of the
multi-sort and subtotals/aggregation features.

Other Contributors
------------------
We received bugfixes and other contributions from the following people:
* Petrosys Pty, Australia (http://www.petrosys.com.au) sponsored the
fix for bug #269.

Rene Bakx
Joachim N?bold
Kevin Golding
Pieter Heijmans
Soh Kok Hong
Kees van Dieren
Nicola
J.Enrique Ruiz [Ruiz]
C?sar Ordi?ana [Cesar]
Harrie Verveer
Thom Dyson
Andres Attemann
Brian Gillis
Martin Looise [MartinL]
Gabriele Gallacci
Fabrizio Vanzani
Dennis-Jan Broerse
Gustavo Espinosa Tavitas
Eldad Ran
Arnold Cano
Danny Peeters
Alberto Galanti
Bas de Nooijer
Tjeerd Bijlsma
Przemek Piotrowski
Olav B. Lygre
Renato Furter
Stefano Salvador
Roberto Berto
Nico de Boer
Klaus ?
Gabriel Achtig
Christian Hudson [ChristianH]
Ludo Beumer
Patrick van der Velden
Kevin L. Winmoe [KevinLW]
Jorge Garifuna [JorgeG]
Fabio Saitta
Jeroen van Sluijs
Bart Helms
Rainer Glaschick [RainerG]
Rich Kucera
Marlon Bilog
Michael Zaugg [MichaelZ]
Michael Anello [MichaelA]
Almer Kaasschieter
Rene van den Ouden [RenevO]
Ruud Alberts
Rik Tonnard [RikT]
Dennis Luitwieler
Edgar van Ispelen
Peter Bottenberg [PeterB]
Mark van der Velden [mvdvelden]
Rik Willems
Arjen Tebbenhof
Vito Chin
Bjorn de Haan
Erik Snoeijs
Michael Stillwell
Wim Kosten
Michele Rota
Max Westen
Lineke Kerckhoffs Willems
Maurice Maas
Alfred Armstrong
Matthieu Giroux
Matthijs van den Bos [Matthijs]
Jos Huiting [jhuiting]
Daan van Renterghem [DVR]
* Funding BV, The Netherlands (http://www.funding.nl), sponsored development
of the Privacy Enhancing Technologies extensions, the atkCurrencyAttribute,
the atkFormatAttribute and improvements to the CSV import feature.

* Dataroomservices, The Netherlands (http://www.dataroomservices.nl), sponsored
development of PDA detection support.

* For Zicht Nieuwe Media Ontwerpers, The Netherlands (http://www.zicht.nl),
sponsored development of the atkShuttleRelation, enhancement of the
atkFckAttribute and the atkFileAttribute autonumbering feature. Zicht also
sponsored a large part of the atkMlWrapper functionality.

* Egeniq, The Netherlands (http://www.egeniq.com) has occasionally contributed
new features and bugfixes (Ivo Jansch co-founded Egeniq after his departure
from ibuildings).

Names between [] are the names they are refered by in the CHANGES file. (If
different from their first name).
###

0 comments on commit cd01231

Please sign in to comment.