Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Antikyth authored Aug 18, 2022
1 parent dbd0ea7 commit 8aaacc6
Showing 1 changed file with 20 additions and 54 deletions.
74 changes: 20 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,23 @@
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at https://mozilla.org/MPL/2.0/. -->

AquariWM is a fully modular window manager, allowing extreme extensibility while remaining easily
approachable.

## Installation
AquariWM is currently in early development and has yet to have a public release. You can clone the
repository and build the code locally if you wish to contribute or test that which has been
completed so far.


## [Contributing](https://github.com/AquariWM/aquariwm/wiki/Contributing-to-AquariWM)
Contributions to AquariWM are heavily appreciated and encouraged! AquariWM aims to be a very
community-oriented project, and we believe that that should mean AquariWM is owned and developed
by the community too. You can find more information about contributing to AquariWM in the
[contributor's document](CONTRIBUTING.md). Every issue, pull request, from simple spelling
corrections to large codebase overhauls, and everything in between, is very much welcome! Even a
small contribution can go a long way!


## How does AquariWM compare to other window managers?

### A welcoming community
We believe community is one of the most important aspects of any project, and that's why we strive
to create a friendly and welcoming community for all, regardless of your level of experience and
free from discrimination, bigotry, arguments, or disrespect. The AquariWM community is a place to
share tips, suggestions, and friendly discussions in general.

### Universal communication
Most other window managers only allow configuration through a limited selection of formats or
languages, typically just one. AquariWM, on the other hand, communicates with departments (and
therefore configuration too) through a universal method of communication, supported by nearly every
single programming language, called Inter Process Communication (IPC for short) sockets. You are
free to use whatever language and/or way of communicating with the window manager you prefer.

### Use it your way
Due to AquariWM's modular approach, there's no limit to the features you can use. If something
you'd like to do doesn't exist, make it! You could even release it as a module under the AquariWM
GitHub organization if you would like, or you could distribute it separately (or even just use it
yourself!) - the choice is yours.

### Complete documentation and extensive guides
AquariWM guarantees that all features and all APIs are fully and thoroughly documented before they
can be merged with the development branch, and that guides have been written for all features
before they can move from the development branch to main. Everything you need to know is available
to read.

### However...
Please keep in mind that AquariWM is still a small project. AquariWM is in early development, and
may not yet provide the full experience of more established window managers. If you would like to
help us change that, why not contribute to the project - we're always looking to improve what we
have, and everything - big or small, even if this is your first time contributing - is welcomed and
appreciated.

## Departments
Unfortunately, there are no departments available for AquariWM at this time.
AquariWM is a window manager focused on complete modularity. It aims to define and implement a
number of X protocol specifions for various core window manager features, allowing different module
clients to work together. For example, AquariWM defines a 'decorator' specifcation that allows window
decorations to be defined as separate clients, independently of any compliant window manager. That
means you can 'mix-and-match' the appearance of window decorations completely independently of the
window manager.

AquariWM is currently in its very early stages. Further development on AquariWM is waiting on
[X.RS](https://github.com/XdotRS/xrs), an X library for Rust that is being made for AquariWM. A big
focus for both X.RS' code and AquariWM's, however, is thorough and extensive comments and
documentation. The goal is that you should be able to read the docs and/or code and be able to
understand what's happening, without requiring much prior knowledge of the internals of X or a window
manager.

AquariWM is created to be a community project: when there is more of an actual code foundation for the
window manager ready, the intention is for it to be largely developed through community contributions.

## When will AquariWM be ready for further development?
I suspect sometime around December 2022 might be when the X library can be used to further develop
AquariWM in a very much pre-alpha state. Stay tuned!

0 comments on commit 8aaacc6

Please sign in to comment.