Building the Editor
- Install Git
- Install Node
- Install Esy (0.5.6 is required)
- Windows-only: Run
npm install -g windows-build-tools(this installs some build tools that aren't included by default on Windows)
- Check and install any system packages for Revery
Build and Run
Build the front-end
NOTE: On Windows, you must build from a shell running as administrator. This is a requirement of esy because creating symlinks requires administrator permissions (more info here: https://github.com/esy/esy/issues/389).
git clone https://github.com/onivim/oni2 cd oni2 esy install esy bootstrap esy build
Install node dependencies
NOTE: The non-standard
node install-node-deps.jsstep instead of
npm installis necessary because the script picks up our vendored node binary.
--checkhealthargument validates all dependencies are available and working.
esy run -f --checkhealth
Run Onivim 2
esy '@test' install
esy '@test' build
esy '@test' run
esy '@bench' install
esy '@bench' build
esy '@bench' run
To create a release build, run:
esy x Oni2 -f --checkhealth
This will create a
_release folder at the root with the application bundle inside.
Once you have a release build created, you can create an
oni2 symlink to point to your development environment.
Run the following from the
Building the Documentation Website