|
14 | 14 |
|
15 | 15 | ## Table of Contents |
16 | 16 |
|
17 | | -1. [Installation](#installation) |
| 17 | +1. [Structure](#structure) |
| 18 | +2. [Installation](#installation) |
18 | 19 | 1. [Neovim](#neovim) |
19 | | -2. [Usage](#usage) |
20 | | -3. [Credits](#credits) |
| 20 | +3. [Usage](#usage) |
| 21 | +4. [Credits](#credits) |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +## Structure |
| 26 | + |
| 27 | +The project is structured the following way: |
| 28 | + |
| 29 | +``` |
| 30 | +/lua/wezterm/types/ |
| 31 | +├── config.lua <== Contains the `Config` class and related data types |
| 32 | +├── enum.lua <== Imports all the `enum/` files |
| 33 | +├── enum/ <== Enum types |
| 34 | +│ ├── copy-mode-assignment.lua <== `CopyModeAssignment` enum types |
| 35 | +│ └── key-assignment.lua <== `KeyAssignment` enum types |
| 36 | +├── events.lua <== Imports all the `events/` files |
| 37 | +├── events/ <== Events type files |
| 38 | +│ ├── gui.lua <== `Gui` event types |
| 39 | +│ ├── multiplexer.lua <== `Mux` event types |
| 40 | +│ ├── window.lua <== `Window` event types |
| 41 | +├── objects.lua <== Imports all the `objects/` files |
| 42 | +├── objects/ <== Objects type files |
| 43 | +│ ├── color.lua <== `Color` object types |
| 44 | +│ ├── exec-domain.lua <== `ExecDomain` object types |
| 45 | +│ ├── local-process-info.lua <== `LocalProcessInfo` object types |
| 46 | +│ ├── mux-domain.lua <== `MuxDomain` object types |
| 47 | +│ ├── mux-tab.lua <== `MuxTab` object types |
| 48 | +│ ├── mux-window.lua <== `MuxWindow` object types |
| 49 | +│ ├── pane-information.lua <== `PaneInformation` object types |
| 50 | +│ ├── pane.lua <== `Pane` object types |
| 51 | +│ ├── spawn-command.lua <== `SpawnCommand` object types |
| 52 | +│ ├── ssh-domain.lua <== `SshDomain` object types |
| 53 | +│ ├── tab-information.lua <== `TabInformation` object types |
| 54 | +│ ├── time.lua <== `Time` object types |
| 55 | +│ ├── tls-domain-client.lua <== `TlsDomainClient` object types |
| 56 | +│ ├── tls-domain-server.lua <== `TlsDomainServer` object types |
| 57 | +│ ├── window.lua <== `Window` object types |
| 58 | +│ ├── wsl-domain.lua <== `WslDomain` object types |
| 59 | +├── wezterm.lua <== Imports all the surrounding files, including the `wezterm/` directory |
| 60 | +├── wezterm/ <== Types for the `wezterm` module |
| 61 | +│ ├── color.lua <== `Wezterm.Color` module types |
| 62 | +│ ├── gui.lua <== `Wezterm.Gui` module types |
| 63 | +│ ├── mux.lua <== `Wezterm.Mux` module types |
| 64 | +│ ├── nerdfonts.lua <== `Wezterm.NerdFonts` module types |
| 65 | +│ ├── plugin.lua <== `Wezterm.Plugin` module types |
| 66 | +│ ├── procinfo.lua <== `Wezterm.ProcInfo` module types |
| 67 | +│ ├── serde.lua <== `Wezterm.Serde` module types |
| 68 | +│ ├── time.lua <== `Wezterm.Time` module types |
| 69 | +└───└── url.lua <== `Wezterm.Url` module types |
| 70 | +``` |
21 | 71 |
|
22 | 72 | --- |
23 | 73 |
|
|
0 commit comments