Skip to content

Commit

Permalink
Update references of mosaic to Zellij in md files
Browse files Browse the repository at this point in the history
  • Loading branch information
henil committed Feb 10, 2021
1 parent 4704510 commit 30f0567
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
@@ -1,6 +1,6 @@
# Contributing to Mosaic
# Contributing to Zellij

Thanks for considering to contribute to mosaic!
Thanks for considering to contribute to Zellij!

**First**: if you're unsure or afraid of anything, just ask on our
[Discord server][discord-invite-link] or submit the issue or pull request anyway.
Expand All @@ -15,24 +15,24 @@ all contributors are expected to adhere to.

## Looking for something to work on?

If you are new contributor to `Mosaic` going through [beginners][good-first-issue]
If you are new contributor to `Zellij` going through [beginners][good-first-issue]
should be a good start or you can join our public
[Discord server][discord-invite-link], we would be happy to help
finding something interesting to work on and guide through.

[discord-invite-link]: https://discord.gg/feHDHahHCz
[good-first-issue]: https://github.com/mosaic-org/mosaic/labels/good%20first%20issue
[good-first-issue]: https://github.com/zellij-org/zellij/labels/good%20first%20issue

## Filing Issues

Bugs and enhancement suggestions are tracked as GitHub issues.

### Lacking API for plugin in mosaic?
### Lacking API for plugin in Zellij?

If you have a plugin idea, but mosaic still doesn't have API required to make
If you have a plugin idea, but Zellij still doesn't have API required to make
the plugin consider opening [an issue][plugin-issue] and describing your requirements.

[plugin-issue]: https://github.com/mosaic-org/mosaic/issues/new?assignees=&labels=plugin%20system
[plugin-issue]: https://github.com/zellij-org/zellij/issues/new?assignees=&labels=plugin%20system

### How Do I Submit A (Good) Bug Report?

Expand Down
6 changes: 3 additions & 3 deletions GOVERNANCE.md
@@ -1,9 +1,9 @@
# Mosaic Governance
Mosaic is an open source project that belongs to those who contribute to it.
# Zellij Governance
Zellij is an open source project that belongs to those who contribute to it.
As such, we feel it's important to codify some rules that seem obvious and straightforward now, but might not be in the future.

## Organization members
Members of the Mosaic organization are in effect those empowered to make decisions for the project. Individual members are trusted to make decisions on their own and to bring larger and more controversial decisions to be decided by the full quorum of members in a real-time meeting or by correspondence.
Members of the Zellij organization are in effect those empowered to make decisions for the project. Individual members are trusted to make decisions on their own and to bring larger and more controversial decisions to be decided by the full quorum of members in a real-time meeting or by correspondence.

## How decisions are made regarding the project
When larger decisions are brought to the full quorum of members, we would like to hear all the voices and dissenting opinions on the decision at hand. Ideally, we would then decide on a course of action by consensus. Only if one cannot be reached, will each member of the organization get a vote. The decision in the majority will be taken.
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Mosaic contributors
Copyright (c) 2020 Zellij contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
24 changes: 12 additions & 12 deletions README.md
Expand Up @@ -2,7 +2,7 @@
<br>
<img src="assets/logo.png" alt="logo" width="200">
<br>
Mosaic
Zellij
<br>
<br>
</h1>
Expand All @@ -18,23 +18,23 @@

# What is this?

Mosaic is a workspace aimed at developers, ops-oriented people and anyone who loves the terminal.
Zellij 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.
Right now Zellij 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)
(note that right now Zellij only supports linux and maybe mac)

mosaic has three modes, which are a bit like vim or tmux:
Zellij 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:
* Command mode - input is interpreted as commands to control Zellij. 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

Expand All @@ -57,14 +57,14 @@ In command mode:
* 2 - switch to next tab
* 3 - switch to previous tab
* x - close focused pane
* q - quit Mosaic
* q - quit Zellij

# What is the current status of the project?

Mosaic is in the last stages of being VT compatible. As much as modern terminals are.
Zellij 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:
Right now, Zellij:
* 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
Expand All @@ -77,7 +77,7 @@ Please, don't do anything important with it. It's currently being stabilized and
# 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.
A lot of the work needed to be done is product work (making decisions about what Zellij 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.
Expand All @@ -97,8 +97,8 @@ This section contains an ever-changing list of the major features that are eithe
- 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.
* <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 Zellij 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? Zellij 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

Expand Down
2 changes: 1 addition & 1 deletion docs/TERMINOLOGY.md
Expand Up @@ -16,4 +16,4 @@ A pty (pseudoterminal) is a character device that emulates a traditional termina
The primary part is the part connected to the terminal emulator. The emulator listens to this part of the channel, reads instructions from it that it uses in order to draw characters on the screen.
The secondary part is used by the program running inside the terminal (eg. the shell) in order to send those instructions.

In Mosaic, there is one pty pair for each terminal pane.
In Zellij, there is one pty pair for each terminal pane.

0 comments on commit 30f0567

Please sign in to comment.