docs(readme): initial

Readme

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aram@poor.dev. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -0,0 +1,74 @@
+<h1 align="center">
+  <br>
+  <img src="mosaic-logo-hexagon.png" alt="logo" width="200">
+  <br>
+  Mosaic
+  <br>
+  <br>
+</h1>
+
+<p align="center">
+  <img src="demo.gif" alt="demo">
+</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.md).
+
+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)
+
+Some temporary controls (these will be changed to something more convenient when the project matures a little):
+  * ctrl-n - split focused pane vertically
+  * ctrl-b - split focused pane horizontally
+  * ctrl-j - resize focused pane down
+  * ctrl-k - resize focused pane up 
+  * ctrl-h - resize focused pane left
+  * ctrl-l - resize focused pane right
+  * ctrl-p - move focus to next pane
+  * ctrl-[ - scroll up in focused pane
+  * ctrl-] - scroll down in focused pane
+  * ctrl-x - close focused pane
+  * ctrl-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.
+Please drop us a line (TODO: team email? gitter? irc?)
+
+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).
+
+# License
+
+MIT

roadmap.md

@@ -0,0 +1,8 @@
+# Roadmap
+This file 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> such as a file explorer that can open files for editing in new panes, a launcher that would open commands in a new pane, a command pane that would run just one command when clicked, changing its frame colour with each exit status it receives appropriately, and many more.
+  * <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.