Commit Graph

63 Commits

Author SHA1 Message Date
Aram Drevekenin
d1cacc3fa8
chore(repo): remove nix support (#2038) 2022-12-20 12:24:19 +01:00
har7an
d1f50150f6
WIP: Use xtask as build system (#2012)
* xtask: Implement a new build system

xtask is a cargo alias that is used to extend the cargo build system
with custom commands. For an introduction to xtask, see here:
https://github.com/matklad/cargo-xtask/

The idea is that instead of writing makefiles, xtask requires no
additional dependencies except `cargo` and `rustc`, which must be
available to build the project anyway.

This commit provides a basic implementation of the `build` and `test`
subcommands.

* xtask/deps: Add 'which'

* xtask/test: Handle error when cargo not found

* xtask/flags: Add more commands

to perform different useful tasks. Includes:

- clippy
- format
- "make" (composite)
- "install" (composite)

Also add more options to `build` to selectively compile plugins or leave
them out entirely.

* xtask/main: Return error when cargo not found

* xtask/build: Add more subtasks

- `wasm_opt_plugins` and
- `manpage`

that perform other build commands. Add thorough documentation on what
each of these does and also handle the new `build` cli flags
appropriately.

* xtask/clippy: Add job to run clippy

* xtask/format: Add job to run rustfmt

* xtask/pipeline: Add composite commands

that perform multiple atomic xtask commands sequentially in a pipeline
sort of fashion.

* xtask/deps: Pin dependencies

* xtask/main: Integrate new jobs

and add documentation.

* xtask: Implement 'dist'

which performs an 'install' and copies the resulting zellij binary along
with some other assets to a `target/dist` folder.

* cargo: Update xflags version

* xtask: Measure task time, update tty title

* xtask: Update various tasks

* xtask: wasm-opt plugins in release builds

automatically.

* xtask/build: Copy debug plugins to assets folder

* xtask: Add 'run' subcommand

* xtask: Add arbitrary args to test and run

* xtask: Rearrange CLI commands in help

* xtask: Add deprecation notice

* docs: Replace `cargo make` with `xtask`

* github: Use `xtask` in workflows.

* xtask: Add support for CI commands

* xtask: Streamline error handling

* github: Use new xtask commands in CI

* xtask: Add 'publish' job

* xtask/publish: Add retry when publish fails

* xtask: Apply rustfmt

* xtask: Refine 'make' deprecation warning

* xtask: add task to build manpage

* contributing: Fix e2e commands

* xtask/run: Add missing `--`

to pass all arguments following `xtask run` directly to the zellij
binary being run.

* xtask: Stay in invocation dir

and make all tasks that need it change to the project root dir
themselves.

* xtask/run: Add `--data-dir` flag

which will allow very quick iterations when not changing the plugins
between builds.

* xtask/ci: Install dependencies without asking

* utils: Allow including plugins from target folder

* utils/assets: Reduce asset map complexity

* utils/consts: Update asset map docs

* xtask: Fix plugin includes

* xtask/test: Build plugins first

because the zellij binary needs to include the plugins.

* xtask/test: Fix formatting

* xtask: Add notice on how to disable it
2022-12-17 13:27:18 +00:00
Rhythm Bansal
4ba52c80cd
made the README more aesthetic (#1885) 2022-11-08 16:48:12 +01:00
f0x52
6d8b513856
Readme: link to documentation pages in-text (#1621) 2022-07-30 22:15:39 +02:00
a-kenji
f3d8b31635
fix(readme): cargo install instructions (#1616) 2022-07-29 18:59:50 +02:00
a-kenji
d71c212fe8
chore(docs): add more matrix links (#1581) 2022-07-10 19:51:01 +02:00
a-kenji
5b0c2633e7
add(README): quick links to documentation (#1473) 2022-06-09 23:23:34 +02:00
Aram Drevekenin
663797f5e3
docs(readme0: adjust installation methods 2022-06-08 15:58:53 +02:00
Aram Drevekenin
298add50d0
docs(readme): add roadmap 2022-05-13 17:16:29 +02:00
a-kenji
12cb2cf0fa
add(readme): built-with-nix badge (#1220)
And improve readability / contrast of the other badges.
2022-03-15 20:12:30 +01:00
Jae-Heon Ji
a6313ef6a0
docs: add cargo-binstall (#1212) 2022-03-14 14:04:31 +09:00
a-kenji
a624cb3510
fix(readme): switch badges and gif (#1180)
Switch the badges and the large gif on the landing page,
makes it easier to see the badges and get in contact with
the project, as well as find the documentation.
2022-03-05 21:19:45 +01:00
a-kenji
acd69ee02a
add(readme): matrix logo to the badge (#1179) 2022-03-05 21:07:29 +01:00
a-kenji
668ee145b0
docs(readme): move install docs to docs (#1150) 2022-02-28 20:32:41 +01:00
Ken Matsui
c1d7ff0c2a
fix(docs): add a link to release page for roadmap (#1123) 2022-02-27 12:01:48 +01:00
Ken Matsui
645735f571
fix(docs): replace the list with a table that is more readable rather than strikethrough (#1088) 2022-02-24 11:04:05 +01:00
Aram Drevekenin
8162f0c6e7
docs(readme): update demo animation (#1086) 2022-02-22 12:30:49 +01:00
Aram Drevekenin
be54e2b2e0
docs(readme): cross out roadmap goal and update demo 2021-12-22 09:20:45 +01:00
a-kenji
cbae0213db
update(readme): update matrix link to new room (#903) 2021-11-26 10:15:10 +01:00
a-kenji
7154fd0de7
add: badge for matrix chat (#902) 2021-11-25 21:19:31 +01:00
a-kenji
639566df15
docs(readme): update new command syntax (#876) 2021-11-17 10:42:44 +01:00
Jae-Heon Ji
c35a6ba938
doc: add INSTALL.md (#857)
* doc: add INSTALL.md

* doc(install): add warning phrase

* doc(install): fix syntax

* doc(install): change the install doc to be for third party
2021-11-15 09:06:13 +01:00
Aram Drevekenin
1cc12a180e
docs(readme): fix email link 2021-09-29 16:14:02 +02:00
Aram Drevekenin
7294f7a989
docs(readme): clean up language 2021-09-29 16:12:56 +02:00
a-kenji
eb22a6c171
Add link to docs to README.md (#732) 2021-09-19 13:38:53 +02:00
Aram Drevekenin
d202cb7394
docs(readme): clarifications 2021-05-17 18:21:31 +02:00
a-kenji
84e4876813 fixup! Add Option for Simplified Layout 2021-05-10 16:51:06 +02:00
matu3ba
7b5e728f9d
README: shortening + add explanation (#470)
* README: shortening + add explanation

explain debug build command for bug reports

* docs(readme): capitalize

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2021-05-07 16:13:20 +02:00
Aram Drevekenin
996c197fcf
docs(readme): add link 2021-04-19 23:02:45 +02:00
Aram Drevekenin
9aaf51400a
docs(readme): fix link 2021-04-19 23:01:33 +02:00
Aram Drevekenin
1692ae171e
docs(readme): some updates 2021-04-19 23:00:02 +02:00
a-kenji
e5fc158503 Add Unbind for Keybindings (#241)
* will unbind all default keybindings for now

* add test for toplevel unbind

* add example/default.yaml

* add example/README.md
2021-04-17 15:05:34 +02:00
Brooks J Rady
a52aa9be97 docs(build): update CONTRIBUTING.md 2021-04-14 19:11:24 +01:00
Brooks J Rady
0e73227fe2 merge(main): update branch with changes from main 2021-04-13 16:17:40 +01:00
Brooks J Rady
d2a7d100ac docs(build): documented the new build system 2021-04-13 16:06:04 +01:00
a-kenji
68737f78ac Config: Fix README 2021-03-26 22:12:01 +01:00
a-kenji
d3a72a27df Add key events documentation
Add key events documentation from termion to the README
2021-03-16 21:14:10 +01:00
a-kenji
e0d0502539 Add config to README 2021-03-13 12:48:27 +01:00
Brooks J Rady
1759fe9538 Sweet victory (and a README update) 2021-02-23 17:06:22 +00:00
Aram Drevekenin
bff6e5acc1
docs(readme): full urls for image assets 2021-02-17 16:06:12 +01:00
Aram Drevekenin
4d69c5c9b1
docs(readme): updates 2021-02-10 13:40:31 +01:00
henil
30f0567d8a Update references of mosaic to Zellij in md files 2021-02-10 12:12:19 +05:30
henil
c906a8b2fa removed CHANGELOG for now and added some more details 2021-02-04 14:51:11 +05:30
henil
3cd3cdaf0d clean up root of project 2021-01-07 15:21:01 +05:30
Aram Drevekenin
51607c655c
docs(readme): update usage hotkeys 2020-12-18 11:13:59 +01:00
Kyle Sutherland-Cash
11e72b3d6b
feat(ux): add a command mode (#42)
* Move the input loop into a separate module

* Proof of concept implementation of command mode

* Update readme to reflect command mode

* Have Esc exit command mode

* Update tests to use command mode and make it transient by default

* Some merge fixes

* fix(tests): add missing COMMAND_TOGGLE and fix false positive test

* style(format): make rustfmt happy

* Update readme to describe command mode

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2020-11-21 15:55:49 +01:00
Aram Drevekenin
ee0167f3af
fix(compatibility): do not interpret esc as scroll-up (#29) 2020-11-08 21:22:46 +01:00
Doron Tsur
1a6106e208 change link to relative 2020-11-04 12:09:06 +02:00
Doron Tsur
d4d9dd9129 small wording 2020-11-04 12:06:55 +02:00
Doron Tsur
d9e4f31c9d moved roadmap to main readme 2020-11-04 11:58:48 +02:00