Skip to content

Commit

Permalink
docs: Update instructions for linux environment setup
Browse files Browse the repository at this point in the history
  • Loading branch information
tomlin7 committed Mar 18, 2024
1 parent 5be1aef commit ba933ca
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,23 @@ Welcome to the contributing guidelines for Biscuit. This document will help you

### Setting up Environment

Python 3.10 or above is required for building Biscuit.

[**Fork**](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the Biscuit repository and clone locally.
```bash
git clone http://github.com/billyeatcookies/biscuit
```
Run `pip install -r requirements.txt` or `poetry install`, your preference. Try to launch biscuit once with `python -m biscuit` and make sure everything looks good.

> [!NOTE]
> [Python](https://python.org/en/download/) 3.10 or above

> [!IMPORTANT]
> Linux distros require some prerequisites to be installed prior to the pip installation
> ```bash
> sudo apt install python3-dev tcl-dev tk-dev \
> fontconfig libfontconfig1 libfontconfig1-dev \
> cmake cmake-data extra-cmake-modules build-essential
> python -m pip install scikit-build
> ```
# Project Structure
Expand Down
14 changes: 13 additions & 1 deletion docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,23 @@ Biscuit is a lightweight, easy to use code editor for any language. We wrote it

## Setting up Environment

Python 3.10 or above is required for building Biscuit.

[**Fork**](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the Biscuit repository and clone locally.
```bash
git clone http://github.com/billyeatcookies/biscuit
```
Run `pip install -r requirements.txt` or `poetry install`, your preference. Try to run biscuit once with `python -m biscuit` and make sure everything looks good.
Run `pip install -r requirements.txt` or `poetry install`, your preference. Try to launch biscuit once with `python -m biscuit` and make sure everything looks good.


> [!IMPORTANT]
> Linux distros require some prerequisites to be installed prior to the pip installation
> ```bash
> sudo apt install python3-dev tcl-dev tk-dev \
> fontconfig libfontconfig1 libfontconfig1-dev \
> cmake cmake-data extra-cmake-modules build-essential
> python -m pip install scikit-build
> ```
### What you'll need
Expand Down

0 comments on commit ba933ca

Please sign in to comment.