Skip to content

Commit

Permalink
second
Browse files Browse the repository at this point in the history
  • Loading branch information
DerThorsten committed Jan 18, 2024
1 parent 1382ee7 commit 515ba50
Showing 1 changed file with 1 addition and 75 deletions.
76 changes: 1 addition & 75 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,81 +5,7 @@
[![Documentation Status](http://readthedocs.org/projects/xeus-javascript/badge/?version=latest)](https://xeus-javascriptreadthedocs.io/en/latest/?badge=latest)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/DerThorsten/xeus-javascript/main?urlpath=/lab/tree/notebooks/xeus-javascript.ipynb)

`xeus-javascript` is a Jupyter kernel for javascript based on the native implementation of the
Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).

## Installation

xeus-javascript has not been packaged for the mamba (or conda) package manager.

To ensure that the installation works, it is preferable to install `xeus-javascript` in a
fresh environment. It is also needed to use a
[miniforge](https://github.com/conda-forge/miniforge#mambaforge) or
[miniconda](https://conda.io/miniconda.html) installation because with the full
[anaconda](https://www.anaconda.com/) you may have a conflict with the `zeromq` library
which is already installed in the anaconda distribution.

The safest usage is to create an environment named `xeus-javascript`

```bash
mamba create -n `xeus-javascript`
source activate `xeus-javascript`
```

<!-- ### Installing from conda-forge
Then you can install in this environment `xeus-javascript` and its dependencies
```bash
mamba install`xeus-javascript` notebook -c conda-forge
``` -->

### Installing from source

Or you can install it from the sources, you will first need to install dependencies

```bash
mamba install cmake cxx-compiler xeus-zmq nlohmann_json cppzmq xtl jupyterlab -c conda-forge
```

Then you can compile the sources (replace `$CONDA_PREFIX` with a custom installation
prefix if need be)

```bash
mkdir build && cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make && make install
```

<!-- ## Trying it online
To try out xeus-javascript interactively in your web browser, just click on the binder link:
(Once Conda Package is Ready)
[![Binder](binder-logo.svg)](https://mybinder.org/v2/gh/DerThorsten/xeus-javascript/main?urlpath=/lab/tree/notebooks/xeus-javascript.ipynb) -->



## Documentation

To get started with using `xeus-javascript`, check out the full documentation

http://xeus-javascript.readthedocs.io


## Dependencies

`xeus-javascript` depends on

- [xeus-zmq](https://github.com/jupyter-xeus/xeus-zmq)
- [xtl](https://github.com/xtensor-stack/xtl)
- [nlohmann_json](https://github.com/nlohmann/json)
- [cppzmq](https://github.com/zeromq/cppzmq)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a
development environment.
`xeus-javascript` works only in jupyterlite!

## License

Expand Down

0 comments on commit 515ba50

Please sign in to comment.