diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 472d6d6c..6584c26e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,27 +2,45 @@ Welcome to the contributing guidelines for Biscuit. This document will help you get started with contributing to Biscuit. -### Setting up Environment +## Setting up Environment -Python 3.11 or above is required for building Biscuit. +> [!NOTE] +> Python 3.11 or above is required for building Biscuit. Fork the Biscuit repository and clone locally. ```bash -git clone http://github.com/tomlin7/biscuit +$ git clone https://github.com/tomlin7/biscuit.git +$ cd biscuit ``` -In the root directory, run `poetry install`. Try to launch biscuit from source with simply `biscuit` (or `poetry run biscuit`) and make sure everything looks good. +Make a virtual environment to prevent dependency conflicts. + +```bash +$ python -m venv .venv +$ source ./.venv/bin/activate +``` > [!IMPORTANT] -> Linux distros require some prerequisites to be installed prior to the pip installation +> Linux distribtions require some system packages to be installed prior to the poetry installation. +> +> For Debian based distributions, > > ```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 +> $ sudo apt install fontconfig libfontconfig1 libfontconfig1-dev cmake cmake-data extra-cmake-modules build-essential +> $ python -m pip install scikit-build > ``` +> +> For Arch Linux based distributions, +> +> ```bash +> $ sudo pacman -Sy +> $ sudo pacman -S base-devel cmake extra-cmake-modules fontconfig tcl tk +> $ python -m pip install scikit-build +> $ python -m pip install tkextrafont +> ``` + +In the root directory, run `poetry install`. Try to launch biscuit from source with simply `biscuit` (or `poetry run biscuit`) and make sure everything looks good. # Project Structure diff --git a/README.md b/README.md index 11c1ec0a..35b0b405 100644 --- a/README.md +++ b/README.md @@ -23,19 +23,28 @@ A lightweight, fast code editor with extensions, semantic code completions, refa You can install the latest release from PyPI by running: ```bash -pip install biscuit-editor +$ pip install biscuit-editor ``` Try running `biscuit --version` in your terminal to check if the installation was successful. - > [!IMPORTANT] -> Linux distros require some prerequisites to be installed prior to the pip installation +> Linux distribtions require some system packages to be installed prior to the poetry installation. > +> For Debian based distributions, > ```bash -> sudo apt install fontconfig libfontconfig1 libfontconfig1-dev \ +> $ 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 +> $ python -m pip install scikit-build > ``` +> +> For Arch Linux based distributions, +> ```bash +> $ sudo pacman -Sy +> $ sudo pacman -S base-devel cmake extra-cmake-modules \ +> fontconfig tcl tk +> $ python -m pip install scikit-build +> > $ python -m pip install tkextrafont ### Standalone Builds diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 75c79909..df1f9024 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,5 +1,8 @@ ## Installation +!!! Note + Python 3.11 or above is required for building Biscuit. + Recommended way to install Biscuit is via pip: ```bash @@ -8,15 +11,24 @@ pip install biscuit-editor Try running `biscuit --version` in your terminal to check if the installation was successful. -!!! Info - Linux distros require some prerequisites to be installed prior to the pip installation +!!! Info "Pre-requisites for Linux" + Linux distribtions require some system packages to be installed prior to the installation. + + For Debian based distributions, ```bash - sudo apt install fontconfig libfontconfig1 libfontconfig1-dev \ - cmake cmake-data extra-cmake-modules build-essential - python -m pip install scikit-build + $ sudo apt install fontconfig libfontconfig1 libfontconfig1-dev cmake cmake-data extra-cmake-modules build-essential + $ python3 -m pip install scikit-build + ``` + For Arch Linux based distributions, + ```bash + $ sudo pacman -Sy + $ sudo pacman -S base-devel cmake extra-cmake-modules fontconfig tcl tk + $ python -m pip install scikit-build + $ python -m pip install tkextrafont ``` For compiling from source code, please check the [installation guide](https://github.com/tomlin7/biscuit/tree/main/scripts). + ### Alternative Installation Methods 1. **Standalone Builds**: