Browse Source

Added some documentation

tags/v0.1.0
Cédric Belin 3 months ago
parent
commit
0c73afa8a3
11 changed files with 181 additions and 1 deletions
  1. +2
    -1
      LICENSE.md
  2. +16
    -0
      README.md
  3. +21
    -0
      doc/about/license.md
  4. +4
    -0
      doc/about/see_also.md
  5. BIN
      doc/img/favicon.ico
  6. +13
    -0
      doc/index.md
  7. +43
    -0
      doc/installation.md
  8. +50
    -0
      etc/mkdocs.yaml
  9. +25
    -0
      etc/phpdoc.xml
  10. +1
    -0
      etc/requirements.txt
  11. +6
    -0
      readthedocs.yaml

+ 2
- 1
LICENSE.md View File

@@ -1,5 +1,6 @@
# MIT License
Copyright © 2005 - 2020 Haxe Foundation
Copyright © 2005 - 2020 Haxe Foundation
Copyright © 2020 Cédric Belin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal


+ 16
- 0
README.md View File

@@ -0,0 +1,16 @@
# Haxe Standard Library for PHP
![Haxe](https://img.shields.io/badge/haxe-%3E%3D4.0.5-brightgreen.svg) ![PHP](https://img.shields.io/packagist/php-v/cedx/haxe.svg) ![Release](https://img.shields.io/packagist/v/cedx/haxe.svg) ![License](https://img.shields.io/packagist/l/cedx/haxe.svg) ![Downloads](https://img.shields.io/packagist/dt/cedx/haxe.svg)

Provides the [Haxe](https://haxe.org) standard library as a reusable [PHP](https://www.php.net) package.

## Documentation
- [User guide](https://docs.belin.io/haxe.php)
- [API reference](https://api.belin.io/haxe.php)

## Development
- [Git repository](https://git.belin.io/cedx/haxe.php)
- [Packagist package](https://packagist.org/packages/cedx/haxe)
- [Submit an issue](https://git.belin.io/cedx/haxe.php/issues)

## License
[Haxe Standard Library for PHP](https://docs.belin.io/haxe.php) is distributed under the MIT License.

+ 21
- 0
doc/about/license.md View File

@@ -0,0 +1,21 @@
# MIT License
Copyright © 2005 - 2020 Haxe Foundation
Copyright © 2020 Cédric Belin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

+ 4
- 0
doc/about/see_also.md View File

@@ -0,0 +1,4 @@
# See also
- [API reference](https://api.belin.io/haxe.php)
- [Packagist package](https://packagist.org/packages/cedx/haxe)
- [Submit an issue](https://git.belin.io/cedx/haxe.php/issues)

BIN
doc/img/favicon.ico View File

Before After

+ 13
- 0
doc/index.md View File

@@ -0,0 +1,13 @@
# Haxe Standard Library <small>for PHP</small>
![Haxe](https://img.shields.io/badge/haxe-%3E%3D4.0.5-brightgreen.svg) ![PHP](https://img.shields.io/packagist/php-v/cedx/haxe.svg) ![Release](https://img.shields.io/packagist/v/cedx/haxe.svg) ![License](https://img.shields.io/packagist/l/cedx/haxe.svg) ![Downloads](https://img.shields.io/packagist/dt/cedx/haxe.svg)

Provides the [Haxe](https://haxe.org) standard library as a reusable [PHP](https://www.php.net) package.

## Quick start
Install the latest version of **Haxe Standard Library for PHP** with [Composer](https://getcomposer.org):

```shell
composer require cedx/haxe
```

For detailed instructions, see the [installation guide](installation.md).

+ 43
- 0
doc/installation.md View File

@@ -0,0 +1,43 @@
# Installation

## Requirements
Before installing **Haxe Standard Library for PHP**, you need to make sure you have [PHP](https://www.php.net)
and [Composer](https://getcomposer.org), the PHP package manager, up and running.

!!! warning
Haxe Standard Library for PHP requires PHP >= **7.4.0**.

You can verify if you're already good to go with the following commands:

```shell
php --version
# PHP 7.4.5 (cli) (built: Apr 14 2020 16:17:19) ( NTS Visual C++ 2017 x64 )

composer --version
# Composer version 1.10.5 2020-04-10 11:44:22
```

!!! info
If you plan to play with the package sources, you will also need
[Robo](https://robo.li) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).

## Installing with Composer package manager

### 1. Install it
From a command prompt, run:

```shell
composer require cedx/haxe
```

### 2. Import it
Now in your [PHP](https://www.php.net) code, you can use:

```php
<?php
use Array_hx;
use Reflect;
use Std;
use haxe\ds\{IntMap, ObjectMap, StringMap, WeakMap};
use php\{Boot, Lib};
```

+ 50
- 0
etc/mkdocs.yaml View File

@@ -0,0 +1,50 @@
site_name: Haxe Standard Library for PHP
site_description: Provides the Haxe standard library as a reusable PHP package.
site_author: Cédric Belin - cedric@belin.io
site_url: https://docs.belin.io/haxe.php

docs_dir: ../doc
site_dir: ../www

repo_name: git.belin.io
repo_url: https://git.belin.io/cedx/haxe.php
edit_uri: ''

copyright: Copyright &copy; 2020 Cédric Belin
extra:
social:
- icon: fontawesome/solid/globe
link: 'https://belin.io'
- icon: fontawesome/brands/github
link: 'https://github.com/cedx'
- icon: fontawesome/brands/twitter
link: 'https://twitter.com/cedxbelin'
- icon: fontawesome/brands/linkedin
link: 'https://linkedin.com/in/cedxbelin'

markdown_extensions:
- admonition
- codehilite
- meta
- toc:
permalink: true

nav:
- Overview: index.md
- Installation: installation.md
- Usage: usage.md
- About:
- License: about/license.md
- See also: about/see_also.md

theme:
favicon: img/favicon.ico
features:
- instant
icon:
logo: fontawesome/solid/book-reader
repo: fontawesome/brands/git-alt
name: material
palette:
accent: purple
primary: purple

+ 25
- 0
etc/phpdoc.xml View File

@@ -0,0 +1,25 @@
<?xml version="1.0"?>
<phpdocumentor
configVersion="3"
xmlns="http://www.phpdoc.org"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://docs.phpdoc.org/latest/phpdoc.xsd">

<title>Haxe Standard Library for PHP</title>
<paths>
<cache>../var/phpdoc</cache>
<output>../doc/api</output>
</paths>
<version number="0.1.0">
<api>
<markers>
<marker>TODO</marker>
</markers>
<source dsn="..">
<path>src</path>
</source>
<visibility>protected</visibility>
<visibility>public</visibility>
</api>
</version>
</phpdocumentor>

+ 1
- 0
etc/requirements.txt View File

@@ -0,0 +1 @@
mkdocs-material

+ 6
- 0
readthedocs.yaml View File

@@ -0,0 +1,6 @@
version: 2
mkdocs:
configuration: etc/mkdocs.yaml
python:
install:
- requirements: etc/requirements.txt

Loading…
Cancel
Save