Skip to content

Latest commit

 

History

History
76 lines (61 loc) · 3.31 KB

README.md

File metadata and controls

76 lines (61 loc) · 3.31 KB
Raw
drawing

By Renée French

nyne

nyne is a library and a collection of tools that enables interacting with acme in ways that are more intuitive when coming from traditional text editors. As a library, nyne provides many abstractions on top of the 9fans acme library to make event handling, finding focused windows, and other actions significantly easier (see Event and the provided variables for example). The included commands make working in acme faster and more user friendly, especially when combined with a keyboard mapping tool like skhd.

These are the commands that are included:

  • cmd/a+: Indent selected source code
  • cmd/a-: Unindent selected source code
  • cmd/aspell: A spell checker for acme
  • cmd/com: Comments/uncomments piped text
  • cmd/f+: Increase font size
  • cmd/f-: Decrease font size
  • cmd/font: Wrapper around f+ or f- intended to be invoked from a tool like skhd
  • cmd/md: Shortcuts for working with markdown
  • cmd/move: Shortcuts for moving the cursor
  • cmd/nstart: Used to launching acme along with all dependencies and helpers
  • cmd/nyne: The core autoformatting engine that is run from within acme
  • cmd/nynetab: Implements tab expansion and indentation
  • cmd/save: Utility to execute Put via keyboard bindings
  • cmd/xcom: Wrapper around com intended to be invoked from a tool like skhd
  • cmd/xec: Execute a command in the focused window as if it had been clicked with B2

Configuration

Nyne and the bundled utilities are configured in config.go which defineshow nyne handles different file types, what to write to the menu, etc. Alter this file to your liking before building and installing nyne.

Several of the included tools are intended to be called from a tool like skhd which allows for overriding the application handlers for particular key bindings. See skhdrc for an example of how to use nyne tooling with skhd.

Install

To install nyne, first make sure that you have properly installed Go and then execute the following commands:

% git clone https://github.com/dnjp/nyne
% cd nyne
% go install ./...

This will build and install the included commands and the nyne library itself.

Bugs or Feature Requests

Please feel free to file an issue if you run into any bugs or problems during normal usage. Should you have any questions about how to use or setup nyne, you can start a new discussion thread.

Contributing

Please do! If you have a fix for a bug or a new feature you'd like added to nyne, please fork this repository, commit your changes to a new branch, and submit a PR with your changes.