GuanM/tabby
1
0
Fork 0
mirror of https://github.com/Eugeny/tabby.git synced 2025-06-08 13:30:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

added info on Linux build deps

Browse Source
This commit is contained in:
Eugene Pankov 2021-06-27 19:08:18 +02:00
parent 4db4d49187
commit 45e6844931
No known key found for this signature in database
GPG Key ID: 5896FCBBDD1CF4F4
1 changed files with 30 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
HACKING.md
View File

@ -4,15 +4,24 @@ Terminus is an Electron app, with the frontend written in Typescript with the he
# Getting started # Getting started
First of all, clone this repository. You'll also need a recent version of Node installed. First of all, clone this repository. You'll also need Node.js 14 or newer and Yarn.
First, install the dependencies: First, install the dependencies:
``` ```
# macOS/Linux: # macOS:
yarn yarn
./scripts/build-native.js ./scripts/build-native.js
```
```
# Linux (Debian here as an example)
sudo apt install libfontconfig-dev libsecret-1-dev bsdtar libnss3
yarn
./scripts/build-native.js
```
```
# Windows: # Windows:
npm -g install windows-build-tools npm -g install windows-build-tools
yarn yarn
@ -31,6 +40,22 @@ Start Terminus with
yarn start yarn start
``` ```
# Building an installer
To build an installer, first complete a "normal" build as described above and then run:
```
node scripts/prepackage-plugins.js
node scripts/build-windows.js
# or
node scripts/build-linux.js
# or
node scripts/build-macos.js
```
The artifacts will be produced in the `dist` folder.
# Project layout # Project layout
``` ```
terminus terminus
@ -43,11 +68,11 @@ terminus
├─ terminus-community-color-schemes # Plugin that provides color schemes ├─ terminus-community-color-schemes # Plugin that provides color schemes
├─ terminus-core # Plugin that provides base UI and tab management ├─ terminus-core # Plugin that provides base UI and tab management
├─ terminus-electron # Plugin that provides Electron-specific functions ├─ terminus-electron # Plugin that provides Electron-specific functions
└─ terminus-local # Plugin that provides local shells and profiles ├─ terminus-local # Plugin that provides local shells and profiles
├─ terminus-plugin-manager # Plugin that installs other plugins ├─ terminus-plugin-manager # Plugin that installs other plugins
├─ terminus-settings # Plugin that provides the settings tab ├─ terminus-settings # Plugin that provides the settings tab
└─ terminus-terminal # Plugin that provides terminal tabs ├─ terminus-terminal # Plugin that provides terminal tabs
├─ terminus-web # Plugin that provides web-specific functions └─ terminus-web # Plugin that provides web-specific functions
``` ```
# Plugin layout # Plugin layout