Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 2.41 KB

installation.md

File metadata and controls

103 lines (68 loc) · 2.41 KB
Raw

Installation Methods

Which One to Use?

The preferred method is to use the AppImage. However, each method has its own pros and cons.

AppImage Phar Package Manager Git Submodule
Cross-Platform ✅ ✅✅ ✅✅
Easy Installation ✅✅ ✅ ✅✅
Less Requirements
(Being Self-Contained)		 ✅✅ ✅ ✅✅
Less (Download) Size ✅ ✅ ✅
Good Startup Performance ✅ ✅✅ ✅
Global Installation ✅ ✅ ✅✅
Easy to Update ✅ ✅ ✅✅ ✅✅
Easy to Use ✅ ✅ ✅✅

Notes

  • JIT (i.e. Just-In-Time compiler) for PHP is enabled by default in the AppImage. Although you can enable it manually for the other methods as well.

Use the AppImage Bundle

See here for instructions.

Use the Phar File

Requirements

  • PHP 8.0+
  • GHDL
  • GTKWave

Getting It

  1. Download Parvaj Phar file.

    wget https://github.com/machitgarha/parvaj/releases/latest/download/parvaj.phar

  2. Make it executable.

    chmod +x parvaj.phar

  3. Put it somewhere in your $PATH.

    # Supposing ~/.local/bin is in your $PATH
mv parvaj.phar ~/.local/bin/parvaj

  4. Done! Make sure the installation was successful:

    parvaj

Via Package Manager

Arch-based Distributions

Use AUR helpers (parvaj-bin):

yay -S parvaj-bin

(Special thanks to @mkoushan for maintaining it)

As Git Submodule

Warning: This method is DEPRECATED. Relying on this is highly discouraged.

Requirements

  • PHP 8.0+
  • Composer
  • GHDL
  • GTKWave

Getting It

  1. Add Parvaj as a Git submodule.

    git submodule add https://github.com/machitgarha/parvaj scripts/parvaj

  2. Install Parvaj dependencies:

    # -d: --working-directory
composer install -d scripts/parvaj

  3. Done! To invoke it, run:

    ./scripts/parvaj/bin/parvaj