Skip to content

Commit

Permalink
trying docs again
Browse files Browse the repository at this point in the history
  • Loading branch information
MelonSmasher committed Jun 9, 2017
1 parent 9ce8764 commit 0f34877
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/Install.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Install

### Requirements:

- php >= 7.0.0
- Redis
- MariaDB/MySQL (tested on MariaDB 10.1)
- [Yarn](https://yarnpkg.com/) -- For development*
- [composer](https://getcomposer.org/)
- NGINX or Apache (tested on NGINX)

PHP Packages:

- php-pecl-redis
- php-pdo
- php-mysqlnd
- php-mcrypt
- php-mbstring
- php-gd
- php-xml
- php-fpm (NGINX only)

---

* Step 1: [Install NGINX](https://github.com/MelonSmasher/NginxInstaller)

* Step 2: Install MariaDB
Expand Down
21 changes: 21 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ORM Core API

[![Build Status](https://travis-ci.org/OpenResourceManager/Core.svg?branch=master)](https://travis-ci.org/OpenResourceManager/Core)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Documentation Status](https://readthedocs.org/projects/openresourcemanagercore/badge/?version=latest)](http://openresourcemanagercore.readthedocs.io/en/latest/?badge=latest)

ORM Core is a REST API designed to house institutional data and act as an intermediate between an existing ERP and an array of applications and systems.

---

### Installation

See the [installation docs](Install.md)

### Update

See the [update docs](Update.md)

### API Specification

See the [API spec](Specification.md)

0 comments on commit 0f34877

Please sign in to comment.