From 7b5e728f9db7d82d9282265bb8fa35d7b05e5622 Mon Sep 17 00:00:00 2001 From: matu3ba Date: Fri, 7 May 2021 16:13:20 +0200 Subject: README: shortening + add explanation (#470) * README: shortening + add explanation explain debug build command for bug reports * docs(readme): capitalize Co-authored-by: Aram Drevekenin --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 17b43ad9f..3751e9acf 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3