From d2bcf2297fa812a87375aecf24f11f6f1ef22416 Mon Sep 17 00:00:00 2001 From: Shirsak Majumder Date: Thu, 24 Oct 2024 22:13:05 +0530 Subject: [PATCH 1/7] docs: Modified commands for standard best practice --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 472d6d6c..12792380 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ 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 http://github.com/tomlin7/biscuit.git ``` 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. @@ -18,10 +18,10 @@ In the root directory, run `poetry install`. Try to launch biscuit from source w > Linux distros require some prerequisites to be installed prior to the pip installation > > ```bash -> sudo apt install python3-dev tcl-dev tk-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 > ``` # Project Structure From f73f19686e8bf95e18fd1187de16734a8dd382da Mon Sep 17 00:00:00 2001 From: Shirsak Majumder Date: Thu, 24 Oct 2024 22:58:20 +0530 Subject: [PATCH 2/7] docs: Added virtual environment creation in set up steps --- CONTRIBUTING.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12792380..89161bdf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,21 +2,29 @@ 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 +$ 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 \ @@ -24,6 +32,8 @@ In the root directory, run `poetry install`. Try to launch biscuit from source w > $ python -m pip install scikit-build > ``` +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 The codebase of Biscuit is divided into 3 main parts: From 37031702fbc5f898e5227ad8453069087b2064d2 Mon Sep 17 00:00:00 2001 From: Shirsak Majumder Date: Thu, 24 Oct 2024 22:58:58 +0530 Subject: [PATCH 3/7] Added Arch Linux set up --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89161bdf..7bf79f8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,14 @@ $ source ./.venv/bin/activate > 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. From 9bcb75a43d1c7d4af2571343fb6ace0d2991bc79 Mon Sep 17 00:00:00 2001 From: Shirsak Majumder Date: Thu, 24 Oct 2024 23:16:56 +0530 Subject: [PATCH 4/7] docs: Added Python version note --- docs/getting-started/installation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 75c79909..b9662162 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 From 7ea30d5dacbb855a748426653d28c5c4d5a05e1f Mon Sep 17 00:00:00 2001 From: Shirsak Majumder Date: Thu, 24 Oct 2024 23:17:28 +0530 Subject: [PATCH 5/7] docs: Added important note --- docs/getting-started/installation.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index b9662162..0e7bc20f 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -11,15 +11,28 @@ 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 - ```bash - sudo apt install fontconfig libfontconfig1 libfontconfig1-dev \ - cmake cmake-data extra-cmake-modules build-essential - python -m pip install scikit-build - ``` +> [!IMPORTANT] +> Linux distribtions require some system packages to be installed prior to the 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 +> ``` +> +> 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**: From 317ca1b198eee40660cd4d0a01d8cac0f95b866b Mon Sep 17 00:00:00 2001 From: Shirsak Majumder Date: Thu, 24 Oct 2024 23:20:52 +0530 Subject: [PATCH 6/7] docs: Updated Arch Linux instructions in README --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) 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 From 598e7b5f3712f4b543b2eba262cb627e60538d9b Mon Sep 17 00:00:00 2001 From: Billy Date: Thu, 24 Oct 2024 23:51:19 +0530 Subject: [PATCH 7/7] docs: Fix admonitions syntax --- CONTRIBUTING.md | 10 ++++---- docs/getting-started/installation.md | 38 +++++++++++++--------------- 2 files changed, 22 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bf79f8b..6584c26e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,20 +25,20 @@ $ source ./.venv/bin/activate > 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 +> $ 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 +> $ 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. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 0e7bc20f..df1f9024 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,7 +1,7 @@ ## Installation -> [!NOTE] -> Python 3.11 or above is required for building Biscuit. +!!! Note + Python 3.11 or above is required for building Biscuit. Recommended way to install Biscuit is via pip: @@ -11,25 +11,21 @@ pip install biscuit-editor Try running `biscuit --version` in your terminal to check if the installation was successful. -> [!IMPORTANT] -> Linux distribtions require some system packages to be installed prior to the 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 -> ``` -> -> 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 -> ``` +!!! 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 + $ 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).