https://github.com/askupasoftware/amarkal

This project has been moved to https://github.com/amarkal
https://github.com/askupasoftware/amarkal

amarkal wordpress wordpress-framework

Last synced: 13 days ago
JSON representation

This project has been moved to https://github.com/amarkal

• Host: GitHub
• URL: https://github.com/askupasoftware/amarkal
• Owner: askupasoftware
• License: gpl-3.0
• Created: 2014-07-04T00:49:30.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-06-10T23:53:40.000Z (over 8 years ago)
• Last Synced: 2024-11-16T01:45:28.285Z (about 1 year ago)
• Topics: amarkal, wordpress, wordpress-framework
• Language: PHP
• Homepage:
• Size: 690 KB
• Stars: 7
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Amarkal Framework 

[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) [![Amarkal Powered](http://www.askupasoftware.com/poweredby.gif)](http://www.askupasoftware.com/)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/amarkal/amarkal/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/amarkal/amarkal/?branch=master)

[![Scrutinizer Build Status](https://scrutinizer-ci.com/g/amarkal/amarkal/badges/build.png?b=master)](https://scrutinizer-ci.com/g/amarkal/amarkal/?branch=master)

- Version: 0.3.6-alpha

- Website: [askupasoftware.com](http://www.askupasoftware.com/)

- Tested up to WordPress 4.1

## Contents

* [Overview](#overview)

* [Requirements](#requirements)

* [Installation](#installation)

    * [Via Git](#via-git)

    * [Via Composer](#via-composer)

    * [Manual install](#manual-install)

* [Updating](#updating)

## Overview

Amarkal is a WordPress development framework that is aimed at simplifying the creation and maintenance of WordPress plugins and themes.

This framework is currently in it's alpha stage and is not ready for production. This means that drastic changes can occur without prior notice. However, some parts of the framework have been fully matured and no major changes are expected for them.

## Requirements

- PHP version 5.4.3 or above

- WordPress 3.7 or above

## Installation

### Via git

1. Clone the Amarkal Git repository to the desired location:

        git clone git://github.com/amarkal/amarkal.git target-directory

    (Where `target-directory` is your desired folder path.)

### Via Composer

1. Create a file named composer.json at the root of your project, containing the Amarkal dependency:

        {

          "require": {

              "askupa-software/amarkal-framework": "dev-master"

          }

        }

2. Install composer in your project:

        curl -s http://getcomposer.org/installer | php

3. Install dependencies

        php composer.phar install

### Manual install 

1. Download the zip archive from the GitHub repository page (or click here:  [amarkal.zip](https://github.com/amarkal/amarkal/archive/master.zip))

2. Unzip the package in the desired location

## Updating

Updating can be done by manually downloading the newer version, or by simply using `git pull` or `php composer.phar update`. The composer version of Amarkal is linked to the GitHub repository, so any updates to the framework will be reflected on both simultaneously.