Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tsoding/cm

Emacs' compilation-mode-like TUI application
https://github.com/tsoding/cm

hacktoberfest hacktoberfest2020

Last synced: 11 days ago
JSON representation

Emacs' compilation-mode-like TUI application

Host: GitHub
URL: https://github.com/tsoding/cm
Owner: tsoding
License: mit
Created: 2020-04-28T16:30:40.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2020-11-03T12:31:37.000Z (about 4 years ago)
Last Synced: 2024-08-01T22:58:06.175Z (3 months ago)
Topics: hacktoberfest, hacktoberfest2020
Language: Rust
Size: 2.35 MB
Stars: 93
Watchers: 5
Forks: 7
Open Issues: 44
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://github.com/tsoding/cm/workflows/CI/badge.svg)](https://github.com/tsoding/cm/actions)

# cm

**WARNING! The application is in an active development state and is not even alpha yet. Use it at your own risk. Nothing is documented, anything can be changed at any moment or stop working at all.**

The goal of this application is to recreate the [compilation-mode] of Emacs as a standalone TUI application.

## Build

### Dependencies

- [rust](https://www.rust-lang.org/)

- [ncurses](https://invisible-island.net/ncurses/)

- [pcre2](https://www.pcre.org/)

### Workflow

```console

$ cargo build

$ ./target/debug/cm 'grep -rn String src/'

```

## Usage

### Default Shortcuts

|Shortcut|Description|

|---|---|

|j or Down|Move cursor down|

|k or up|Move cursor up|

|Alt+j or Alt+Down|Move cursor to the next match|

|Alt+k or Alt+Up|Move cursor to the prev match|

Rest default shortcuts are [TBD](https://github.com/tsoding/cm/issues/87)

### Application layout

[TBD](https://github.com/tsoding/cm/issues/86)

### Configuration file cm.conf

[TBD](https://github.com/tsoding/cm/issues/45)

### Self-recurring

## Examples

## Searching with grep

[![asciicast](https://asciinema.org/a/327091.svg)](https://asciinema.org/a/327091)

## Fixing compilation errors

[![asciicast](https://asciinema.org/a/337846.svg)](https://asciinema.org/a/337846)

[compilation-mode]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Compilation-Mode.html