Skip to content
This repository was archived by the owner on Dec 27, 2023. It is now read-only.

Commit 0045fd8

Browse files
committed
Added documentation
1 parent c5c2d16 commit 0045fd8

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Jupyter-PHP Installer ([Main Page](https://litipk.github.io/Jupyter-PHP-Installer/))
2+
3+
[![Author](http://img.shields.io/badge/author-@castarco-blue.svg?style=flat-square)](https://twitter.com/castarco)
4+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
5+
[![Packagist Version](https://img.shields.io/packagist/v/Litipk/jupyter-php.svg?style=flat-square)](https://packagist.org/packages/Litipk/jupyter-php)
6+
7+
## Introduction
8+
9+
[**Jupyter-PHP**](https://github.com/Litipk/Jupyter-PHP) is a PHP kernel for [*Jupyter*](http://jupyter.org). This
10+
repository holds an installer to make easier installing the Jupyter-PHP kernel.
11+
12+
## Getting started
13+
14+
Go to the [main page](https://litipk.github.io/Jupyter-PHP-Installer/) and follow the instructions.
15+
16+
## Learn more
17+
18+
* [Chat Room](https://gitter.im/Litipk/Jupyter-PHP) : If you want to have a real-time chat with other Jupyter-PHP users or developers, you can do it here.
19+
* [Group / Mail List](https://groups.io/g/jupyter-php) : If a chat room isn't enough to post your doubts or ideas, you can join to our mail list.
20+
21+
## How to contribute
22+
23+
* First of all, you can take a look on the [bugtracker](https://github.com/Litipk/Jupyter-PHP-Installer/issues) and decide if there is something that you want to do :wink: . If you think there are missing improvements in this file, then you are invited to modify the TODO list.
24+
* You can also send us bug reports using the same bugtracker.
25+
* If you are really interested on helping to improve Litipk\BigNumbers, we recommend to read the [contributing guidelines](https://github.com/Litipk/Jupyter-PHP-Installer/blob/master/CONTRIBUTING.md).
26+
27+
28+
## License
29+
30+
Jupyter-PHP and its installer are licensed under the [MIT License](https://github.com/Litipk/Jupyter-PHP-Installer/blob/master/LICENSE).

0 commit comments

Comments
 (0)