Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
doc updates for community-led project
- Loading branch information
Showing
7 changed files
with
4,468 additions
and
486 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.