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

Commit 3135a1e

Browse files
committed
First README text
1 parent 6027c7a commit 3135a1e

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Jupyter-PHP
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** is a PHP kernel for [*Jupyter*](http://jupyter.org). This project is inspired on
10+
[https://github.com/dawehner/jupyter-php](https://github.com/dawehner/jupyter-php), some bits of code from the old
11+
*IPython* kernel have been used in this new *Jupyter* kernel.
12+
13+
In addition to the Jupyter compatibility, the new Jupyter-PHP adds a lot of improvements, like the integration with
14+
[PsySH](http://psysh.org/) in order to provide:
15+
16+
* *"memory"*: the old kernel was unable to keep variables to allow reuse them later.
17+
* online documentation with the `doc` command. *Not yet implemented*
18+
* code introspection with the `ls` command. *Not yet implemented*
19+
* errors introspection with the `wtf` command. *Not yet implemented*
20+
21+
## Getting started
22+
23+
To be written.
24+
25+
## Learn more
26+
27+
* [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.
28+
* [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.
29+
30+
## How to contribute
31+
32+
* First of all, you can take a look on the [bugtracker](https://github.com/Litipk/php-bignumbers/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.
33+
* You can also send us bug reports using the same bugtracker.
34+
* If you are really interested on helping to improve Litipk\BigNumbers, we recommend to read the [contributing guidelines](https://github.com/Litipk/php-bignumbers/blob/master/CONTRIBUTING.md).
35+
36+
37+
## License
38+
39+
Jupyter-PHP is licensed under the [MIT License](https://github.com/Litipk/Jupyter-PHP/blob/master/LICENSE).

0 commit comments

Comments
 (0)