pogmommy/zellij
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: shortening + add explanation (#470)

Browse source 
* README: shortening + add explanation

explain debug build command for bug reports

* docs(readme): capitalize

Co-authored-by: Aram Drevekenin <aram@poor.dev>
This commit is contained in:
matu3ba 2021-05-07 16:13:20 +02:00 • committed by GitHub
parent b2efb68a6e
commit 7b5e728f9d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -36,12 +36,12 @@ cargo install zellij
Or you can download a prebuilt binary from our [Releases](https://github.com/zellij-org/zellij/releases).
## How do I hack on it?
## How do I hack on it? (Contributing)
* Clone the project
* Install cargo-make with `cargo install --force cargo-make`
* In the project folder, run: `cargo make run`
* In the project folder, for debug builds run: `cargo make run`
For more build commands, take a look at [`Contributing.md`](CONTRIBUTING.md).
For more build commands, see [`Contributing.md`](CONTRIBUTING.md).
## Configuration
For configuring Zellij, please see the [Configuration documentation](https://zellij.dev/documentation/configuration.html).
@ -68,11 +68,6 @@ This section contains an ever-changing list of the major features that are eithe
* **Support for multiple terminal windows across screens** - Transfer panes across different windows and screens by having them all belong to the same session.
* **Smart layouts** - expand the current layout system so that it rearranges and hides panes intelligently when new ones are added or the window size is changed.
## Contributing
Take a look at [`Contributing.md`](CONTRIBUTING.md) guide.
## License
MIT