This section will guide you through setting up the required environment to develop rakuyomi.

Before proceeding, you'll need the following tools installed:

• Linux, macOS or Windows (under WSL)
• A working Git installation
• devenv, used to centralize development dependencies
• direnv, used to automatically enter the development environment generated by devenv
• Visual Studio Code

Running KOReader under WSL requires [WSLg](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps) to be configured.

First, clone the repository, copy the .envrc.dist to .envrc and allow it to be loaded:

$ git clone https://github.com/tachibana-shin/rakuyomi.git
$ cd rakuyomi
$ cp .envrc.dist .envrc
$ direnv allow

If you've enabled [direnv's shell integration](https://direnv.net/docs/hook.html), you should automatically enter a _developer shell_: a shell containing all development dependencies and useful scripts!

Don't worry if you haven't though, you can always enter it by yourself by running `devenv shell`.

After that, open the repository in VSCode. You'll be prompted to install the recommended extensions – installing them is highly recommended, as it'll make developing rakuyomi much easier.

After installing the recommended extensions, another prompt will show up - asking whether you want to reload the environment. Accept it, and then you're ready to work with rakuyomi! Here are some useful commands available in the development environment:

• dev: starts KOReader with the rakuyomi plugin built from source. Run this in your terminal when you want to test your changes.
• debug: starts KOReader with the rakuyomi plugin, and attaches a Rust debugger to the server process. Use this when you need to debug issues in the server component.