atxrenegade / flatiron_ruby_cli_portfolio

A ruby gem CLI application for searching and listing ATOM keyboard shortcuts for Windows, Linux and MacOS

Atom Shortcuts

Welcome to Atom Shortcuts!

This is a utility gem designed for as a quick reference to many of the atom shortcuts. Being familiar with shortcuts and important commands speeds up your workflow and increases your productivity as a programmer. This gem includes atom shortcuts for MacOS, Windows, and Linux operating systems. There is a search by name, and search by key sequence function, and users can select and individual shortcuts for a detailed view.

Harleigh/atxrenegade

Usage

To use this gem:

1. Download appication from the Github Repository or from RubyGems.com
2. Type 'bundle install' into command line.
3. To run executable type 'ruby atom_shortcuts' into command line.

This GEM upon execution will display a greeting and directions to proceed. Press the enter key to bring up the main menu. Here you can select your operating system or exit the program. Once you have selected your operating system you will have a choice to list all commands, search shortcuts by name, or search shortcuts by key sequence.

If you select LIST ALL, a full list of commands will be displayed. If you would like to view details for a specific shortcut type in the number press enter and you will bering up the detailed view for that shortcut. From here you can choose another shortcut by number, exit to the search menu, or back to the main menu to choose a different operating system.

If you select SEARCH BY NAME, you will be prompted to enter a name or search term to look for this shortcut. If a shortcut for this operating system matches your search term it will return the detailed view for that shortcut.

If you select SEARCH BY KEY, you will be prompted to enter a key sequence to look up. If a shortcut for this operating system matches your search term it will return the detailed view for that shortcut.

From the MAIN MENU and the SHORTCUT MENU you can EXIT by entering "x".

This application is easy to use and each stage will prompt you for the expected response.

Development

After checking out the repo, run bundle install to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/atxrenegade/flatiron_ruby_cli_portfolio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Atom Shortcuts project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Acknowledgments

• Contributer(s): Nils Winkler - author of the Github page displaying the atom shortcuts scraped for this application. (https://github.com/nwinkler/atom-keyboard-shortcuts)