Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme with latest instructions and requirements #60

Merged
merged 2 commits into from
Jul 11, 2023
Merged

Update readme with latest instructions and requirements #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23e0e3e
Update readme with instructions for installation and fix python version
steff456 Jul 3, 2023
33ee983
add review comments
steff456 Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,24 +54,29 @@ This font can only be changed for the `Markdown viewer` and the `Terminal`. You

## 📦 Requirements

- [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) >= 3.0
- [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) < 4.0
Copy link
Contributor

@gabalafou gabalafou Jul 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be >= 3.0, <4.0?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes good catch


<!-- Will comment this section as it is not yet applicable, and was leftover from the cookiecutter -->
<!-- ## 🏗 Installing the extension
## 🏗 Installing the extension

To install the extension, execute:
You can install the extension using `pip`:

```bash
pip install jupyterlab_accessible_themes
```

If you prefer `conda`:

```bash
conda install -c conda-forge jupyterlab_accessible_themes
```

## 🧽 Uninstalling the extension

To remove the extension, execute:

```bash
pip uninstall jupyterlab_accessible_themes
``` -->
```

## 🙋🏽‍♀️ Contributing

Expand All @@ -80,7 +85,7 @@ pip uninstall jupyterlab_accessible_themes
#### Pre-requisites

1. You will need to have [NodeJS](https://nodejs.org/en/download/) installed in your local computer to build the extension package.
2. Python >= 3.6 and pip.
2. Python >= 3.8 and pip.

##### Building and linking the extension

Expand Down Expand Up @@ -239,9 +244,6 @@ More information are provided within the [ui-tests](./ui-tests/README.md) README

Detailed instructions for creating a `jupyterlab-accesible-themes` can be found in the [RELEASE](RELEASE.md) file.

> **Warning**
> As of 3rd of August this projects is still in its infancy and no releases are made yet.

## 📖 License

[This project is licensed under the BSD-3-Clause license](https://opensource.org/licenses/BSD-3-Clause).
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ ignore = [
".*",
"package-lock.json"
]

[project]
name = "jupyterlab_accessible_themes"
requires-python = ">=3.8"