Updated README.md
This commit is contained in:
parent
d14875170e
commit
fcd2408933
1 changed files with 41 additions and 14 deletions
55
README.md
55
README.md
|
@ -4,26 +4,53 @@ A logging library for PHP/ncc, this was quickly thrown together
|
|||
to provide a simple logging interface and to test out
|
||||
NCC's capabilities for PHP.
|
||||
|
||||
## Getting started
|
||||
## Table of Contents
|
||||
|
||||
First
|
||||
<!-- TOC -->
|
||||
* [LogLib](#loglib)
|
||||
* [Table of Contents](#table-of-contents)
|
||||
* [Installation](#installation)
|
||||
* [Compiling from source](#compiling-from-source)
|
||||
<!-- TOC -->
|
||||
|
||||
|
||||
### building
|
||||
## Installation
|
||||
|
||||
The library can be installed using ncc:
|
||||
|
||||
```bash
|
||||
$ git clone https://git.n64.cc/nosial/libs/loglib.git
|
||||
$ cd loglib
|
||||
|
||||
$ ncc build --config release
|
||||
# or
|
||||
$ make release
|
||||
ncc install -p "nosial/libs.log=latest@n64"
|
||||
```
|
||||
|
||||
### installing
|
||||
or by adding the following to your project.json file under
|
||||
the `build.dependencies` section:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "net.nosial.loglib",
|
||||
"version": "latest",
|
||||
"source_type": "remote",
|
||||
"source": "nosial/libs.log=latest@n64"
|
||||
}
|
||||
```
|
||||
|
||||
If you don't have the n64 source configured you can add it
|
||||
by running the following command:
|
||||
|
||||
```bash
|
||||
$ sudo ncc install -p="build/release/net.nosial.loglib.ncc"
|
||||
# or
|
||||
$ sudo make install
|
||||
```
|
||||
ncc source add --name n64 --type gitlab --host git.n64.cc
|
||||
```
|
||||
|
||||
## Compiling from source
|
||||
|
||||
The library can be compiled from source using ncc:
|
||||
|
||||
```bash
|
||||
ncc build --config release
|
||||
```
|
||||
|
||||
or by running the following command:
|
||||
|
||||
```bash
|
||||
make release
|
||||
```
|
||||
|
|
Loading…
Add table
Reference in a new issue