mirror of
https://github.com/zellij-org/zellij.git
synced 2024-12-27 19:21:52 +03:00
Move the README and link it to the zellij crate
This commit is contained in:
Brooks J Rady
parent
50ec879933
commit
dc9e2b1e6c
109
README.md
Normal file
109
README.md
Normal file
@ -0,0 +1,109 @@
|
||||
<h1 align="center">
|
||||
<br>
|
||||
<img src="assets/logo.png" alt="logo" width="200">
|
||||
<br>
|
||||
Mosaic
|
||||
<br>
|
||||
<br>
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/demo.gif" alt="demo">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/CrUAFH3"><img alt="Discord Chat" src="https://img.shields.io/discord/771367133715628073"></a>
|
||||
</p>
|
||||
|
||||
|
||||
# What is this?
|
||||
|
||||
Mosaic is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal.
|
||||
At its core, it is a terminal multiplexer (similar to [tmux](https://github.com/tmux/tmux) and [screen](https://www.gnu.org/software/screen/)), but this is merely its infrastructure layer.
|
||||
|
||||
For more details, read about upcoming features in our [roadmap](#roadmap).
|
||||
|
||||
Right now Mosaic is in its early development stages and is not yet ready for everyday usage.
|
||||
If you're interested, watch this space or better yet - get involved!
|
||||
|
||||
## How to use it?
|
||||
* Clone the project
|
||||
* In the project folder, run: `cargo run`
|
||||
|
||||
(note that right now Mosaic only supports linux and maybe mac)
|
||||
|
||||
mosaic has three modes, which are a bit like vim or tmux:
|
||||
* Normal mode - allows you to enter text, input will be sent through to stdin on the pane you're typing in
|
||||
* Command mode - input is interpreted as commands to control mosaic. This comes in two variants:
|
||||
* Temporary - once a single valid command has been parsed, returns to normal mode (e.g. quickly opening a new pane and start typing)
|
||||
* Permanent - remain in command mode until you issue the exit command mode command
|
||||
|
||||
The keys and behavior will update when the project matures a bit, but for now:
|
||||
* ctrl-g to cycle between modes (normal mode -> temporary command mode -> permanent command mode -> normal mode)
|
||||
* Esc - exit command mode (any) and return to normal mode
|
||||
|
||||
In command mode:
|
||||
* n - split focused pane vertically
|
||||
* b - split focused pane horizontally
|
||||
* z - split largest terminal on screen (vertically or horizontally)
|
||||
* j - resize focused pane down
|
||||
* k - resize focused pane up
|
||||
* h - resize focused pane left
|
||||
* l - resize focused pane right
|
||||
* p - move focus to next pane
|
||||
* PgUp - scroll up in focused pane
|
||||
* PgDown - scroll down in focused pane
|
||||
* 1 - new tab
|
||||
* 2 - switch to next tab
|
||||
* 3 - switch to previous tab
|
||||
* x - close focused pane
|
||||
* q - quit Mosaic
|
||||
|
||||
# What is the current status of the project?
|
||||
|
||||
Mosaic is in the last stages of being VT compatible. As much as modern terminals are.
|
||||
Most things should work inside a terminal pane, but some edge cases don't.
|
||||
|
||||
Right now, Mosaic:
|
||||
* Successfully renders shells (all experiments have been done with fish-cli).
|
||||
* Can split the terminal into multiple horizontal/vertical panes
|
||||
* Can resize panes, as well as close them
|
||||
* Can scroll up and down inside a pane
|
||||
* Can render a vim pane
|
||||
* Can render most so called "raw mode" applications that draw a textual user interface and refresh themselves.
|
||||
|
||||
Please, don't do anything important with it. It's currently being stabilized and still panics quite a bit. :)
|
||||
|
||||
# How do I get involved?
|
||||
|
||||
At the moment, the project is in early development and prototyping.
|
||||
A lot of the work needed to be done is product work (making decisions about what Mosaic will be and do) as well as development work. So note that most tasks would probably involve a little of both.
|
||||
We're a small team of enthusiasts, and we eagerly welcome people who would like to join in at this early stage.
|
||||
|
||||
Because of the above, it's not trivial for us to have issues tagged "Help Wanted" or "Good First Issue", as all work would likely need some prior discussion.
|
||||
That said, we would absolutely love to have these discussions and to bring more people on. Even if you are unsure of your abilities or have never contributed to open source before.
|
||||
To get started, join our chat and let us know you're interested in contributing: https://discord.gg/CrUAFH3
|
||||
|
||||
We respectfully ask that you do your best to stand by any commitments you make.
|
||||
|
||||
And most importantly, please read our [code of conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
# Roadmap
|
||||
This section contains an ever-changing list of the major features that are either currently being worked on, or planned for the near future.
|
||||
|
||||
* <b>A layout engine</b> that would allow you to define how your panes will be (re)arranged when you open or close them. As well as when you change the terminal window size.
|
||||
* <b>Pane types beyond a simple shell prompt</b>, for example:
|
||||
- A file explorer (similar to ranger) that opens files for editing in a new pane.
|
||||
- A launcher that opens any command you enter in a new pane
|
||||
- A command pane that would run any command, display its output and re-run that command when clicked. Changing its frame colour to green/yellow/red depending on the exit status.
|
||||
* <b>A Webassembly plugin system for compiled languages</b> built using WASI to allow you to write plugins in any compiled language. These plugins would be able to create new panes, interact with existing ones, interact with the filesystem and subscribe to events. You could consume them at runtime and decide what permissions to give them.
|
||||
* <b>Built in support for portable workspaces across machines, projects and teams</b>: imagine being able to include a configuration file with your project that would include all the layouts and plugins that would best help new developers getting onboarded. Including all the shortcuts, customized panes and help-message hints triggered by things such as opening a file, entering a folder or running a command. How about being able to log into a new server or container, start mosaic with a URL of a git repository including your favorite configuration and plugins, and working with it as if you were on your own machine?
|
||||
* <b>Support for multiple terminal windows across screens</b>: Why limit yourself to one terminal window? Mosaic would allow you to transfer panes, view powerlines, get alerts and control your workspace from different windows by having them all belong to the same session.
|
||||
|
||||
# Contributing
|
||||
|
||||
Take a look at [`Contributing.md`](CONTRIBUTING.md) guide.
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
109
zellij/README.md
109
zellij/README.md
@ -1,109 +0,0 @@
|
||||
<h1 align="center">
|
||||
<br>
|
||||
<img src="assets/logo.png" alt="logo" width="200">
|
||||
<br>
|
||||
Mosaic
|
||||
<br>
|
||||
<br>
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/demo.gif" alt="demo">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://discord.gg/CrUAFH3"><img alt="Discord Chat" src="https://img.shields.io/discord/771367133715628073"></a>
|
||||
</p>
|
||||
|
||||
|
||||
# What is this?
|
||||
|
||||
Mosaic is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal.
|
||||
At its core, it is a terminal multiplexer (similar to [tmux](https://github.com/tmux/tmux) and [screen](https://www.gnu.org/software/screen/)), but this is merely its infrastructure layer.
|
||||
|
||||
For more details, read about upcoming features in our [roadmap](#roadmap).
|
||||
|
||||
Right now Mosaic is in its early development stages and is not yet ready for everyday usage.
|
||||
If you're interested, watch this space or better yet - get involved!
|
||||
|
||||
## How to use it?
|
||||
* Clone the project
|
||||
* In the project folder, run: `cargo run`
|
||||
|
||||
(note that right now Mosaic only supports linux and maybe mac)
|
||||
|
||||
mosaic has three modes, which are a bit like vim or tmux:
|
||||
* Normal mode - allows you to enter text, input will be sent through to stdin on the pane you're typing in
|
||||
* Command mode - input is interpreted as commands to control mosaic. This comes in two variants:
|
||||
* Temporary - once a single valid command has been parsed, returns to normal mode (e.g. quickly opening a new pane and start typing)
|
||||
* Permanent - remain in command mode until you issue the exit command mode command
|
||||
|
||||
The keys and behavior will update when the project matures a bit, but for now:
|
||||
* ctrl-g to cycle between modes (normal mode -> temporary command mode -> permanent command mode -> normal mode)
|
||||
* Esc - exit command mode (any) and return to normal mode
|
||||
|
||||
In command mode:
|
||||
* n - split focused pane vertically
|
||||
* b - split focused pane horizontally
|
||||
* z - split largest terminal on screen (vertically or horizontally)
|
||||
* j - resize focused pane down
|
||||
* k - resize focused pane up
|
||||
* h - resize focused pane left
|
||||
* l - resize focused pane right
|
||||
* p - move focus to next pane
|
||||
* PgUp - scroll up in focused pane
|
||||
* PgDown - scroll down in focused pane
|
||||
* 1 - new tab
|
||||
* 2 - switch to next tab
|
||||
* 3 - switch to previous tab
|
||||
* x - close focused pane
|
||||
* q - quit Mosaic
|
||||
|
||||
# What is the current status of the project?
|
||||
|
||||
Mosaic is in the last stages of being VT compatible. As much as modern terminals are.
|
||||
Most things should work inside a terminal pane, but some edge cases don't.
|
||||
|
||||
Right now, Mosaic:
|
||||
* Successfully renders shells (all experiments have been done with fish-cli).
|
||||
* Can split the terminal into multiple horizontal/vertical panes
|
||||
* Can resize panes, as well as close them
|
||||
* Can scroll up and down inside a pane
|
||||
* Can render a vim pane
|
||||
* Can render most so called "raw mode" applications that draw a textual user interface and refresh themselves.
|
||||
|
||||
Please, don't do anything important with it. It's currently being stabilized and still panics quite a bit. :)
|
||||
|
||||
# How do I get involved?
|
||||
|
||||
At the moment, the project is in early development and prototyping.
|
||||
A lot of the work needed to be done is product work (making decisions about what Mosaic will be and do) as well as development work. So note that most tasks would probably involve a little of both.
|
||||
We're a small team of enthusiasts, and we eagerly welcome people who would like to join in at this early stage.
|
||||
|
||||
Because of the above, it's not trivial for us to have issues tagged "Help Wanted" or "Good First Issue", as all work would likely need some prior discussion.
|
||||
That said, we would absolutely love to have these discussions and to bring more people on. Even if you are unsure of your abilities or have never contributed to open source before.
|
||||
To get started, join our chat and let us know you're interested in contributing: https://discord.gg/CrUAFH3
|
||||
|
||||
We respectfully ask that you do your best to stand by any commitments you make.
|
||||
|
||||
And most importantly, please read our [code of conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
# Roadmap
|
||||
This section contains an ever-changing list of the major features that are either currently being worked on, or planned for the near future.
|
||||
|
||||
* <b>A layout engine</b> that would allow you to define how your panes will be (re)arranged when you open or close them. As well as when you change the terminal window size.
|
||||
* <b>Pane types beyond a simple shell prompt</b>, for example:
|
||||
- A file explorer (similar to ranger) that opens files for editing in a new pane.
|
||||
- A launcher that opens any command you enter in a new pane
|
||||
- A command pane that would run any command, display its output and re-run that command when clicked. Changing its frame colour to green/yellow/red depending on the exit status.
|
||||
* <b>A Webassembly plugin system for compiled languages</b> built using WASI to allow you to write plugins in any compiled language. These plugins would be able to create new panes, interact with existing ones, interact with the filesystem and subscribe to events. You could consume them at runtime and decide what permissions to give them.
|
||||
* <b>Built in support for portable workspaces across machines, projects and teams</b>: imagine being able to include a configuration file with your project that would include all the layouts and plugins that would best help new developers getting onboarded. Including all the shortcuts, customized panes and help-message hints triggered by things such as opening a file, entering a folder or running a command. How about being able to log into a new server or container, start mosaic with a URL of a git repository including your favorite configuration and plugins, and working with it as if you were on your own machine?
|
||||
* <b>Support for multiple terminal windows across screens</b>: Why limit yourself to one terminal window? Mosaic would allow you to transfer panes, view powerlines, get alerts and control your workspace from different windows by having them all belong to the same session.
|
||||
|
||||
# Contributing
|
||||
|
||||
Take a look at [`Contributing.md`](CONTRIBUTING.md) guide.
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
1
zellij/README.md
Symbolic link
1
zellij/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
Loading…
Reference in New Issue
Block a user