Skip to content

Commit

Permalink
Split files to remove confusion.
Browse files Browse the repository at this point in the history
Closes #76
  • Loading branch information
NoUseFreak committed Mar 14, 2015
1 parent 122784f commit 5693a55
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 62 deletions.
50 changes: 50 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Development
===========

Installation
------------

First [fork](https://github.com/Clastic/Clastic/fork) the project.

1. Clone the project

```
$ git clone git@github.com:[you]/Clastic.git
$ cd Clastic
$ git remote add upstream git@github.com:Clastic/Clastic.git
````

2. Install

```
$ make install
```

3. Setup development env

```
$ make dev
```

Update
------

1. Update your source

```
$ git fetch upstream
$ git checkout master
$ git rebase upstream/master
```

2. Setup new assets

```
$ make update
```

3. Start development env

```
$ make dev
```
77 changes: 15 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,38 @@
Clastic Development
===================
Clastic
=======

[![Build Status](https://img.shields.io/travis/Clastic/Clastic/master.svg?style=flat-square)](https://travis-ci.org/Clastic/Clastic)
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

This project should only be used for development.
Clastic is a PHP CMS. It is written on top of [symfony](http://symfony.com).
It allows developers to build better applications without the fuss of creating a backoffice.

# Requirements
Clastic can be used as a backend for any type of application, from personal blog to high traffic mobile app api.

Requirements
------------

PHP 5.3.2 or above

You need the following installed globally on your system:
- [composer](http://getcomposer.org)
- [nodejs and npm](http://nodejs.org)
- [gulp](http://gulpjs.com)

# Installation

First [fork](https://github.com/Clastic/Clastic/fork) the project.

1. Clone the project

```
$ git clone git@github.com:[you]/Clastic.git
$ cd Clastic
$ git remote add upstream git@github.com:Clastic/Clastic.git
````

2. Install

```
$ make install
```

3. Setup development env

```
$ make dev
```

# Update

1. Update your source

```
$ git fetch upstream
$ git checkout master
$ git rebase upstream/master
```

2. Setup new assets

```
$ make update
```
Installation
------------

3. Start development env
The best way to install Clastic is to download the Standard Edition.

```
$ make dev
```
Detailed information available at [http://clastic.nousefreak.be/download](http://clastic.nousefreak.be/download).

Contributing
------------

> All code contributions - including those of people having commit access - must
> go through a pull request and approved by a core developer before being
> merged. This is to ensure proper review of all the code.
>
> Fork the project, create a feature branch, and send us a pull request.
>
> To ensure a consistent code base, you should make sure the code follows
> the [Coding Standards](http://symfony.com/doc/2.0/contributing/code/standards.html)
> which we borrowed from Symfony.
> Make sure to check out [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) as this will help you a lot.
Check the [CONTRIBUTING.md documentation](CONTRIBUTING.md).

If you would like to help, take a look at the [list of issues](http://github.com/Clastic/Clastic/issues).

Requirements
------------

PHP 5.3.2 or above

Author and contributors
-----------------------

Expand Down

0 comments on commit 5693a55

Please sign in to comment.