Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.46 KB

README.md

File metadata and controls

42 lines (24 loc) · 1.46 KB

homework

This project is using README Driven Development to document the requirements of the application. The functionality will match the documentation at version 1.0.0. Until then, consider the documentation unreliable.

Note when you run homework init, you will see [conflict] appear in the console. There is no conflict, but is due to a plugin and will be fixed before 1.0.

Description

homework is a tool for managing homework assignments for a primarily code-based curriculum. It was developed for and is used by the courses at The Iron Yard.

Run homework help to get a list of available commands.

Installation

The primary way to install homework is using npm:

$ npm install -g theironyard/homework

For alternative installation methods, see INSTALL.md

Configuration

homework is configurable via command line switches, environment variables, user config files, or a global config file.

See homework-config for more details.

Autocompletion

Add homework setup to your shell to enable autocompletion.

$ echo 'eval "$(homework setup -)"' >> ~/.bash_profile

Ubuntu Desktop note: Modify your ~/.bashrc instead of ~/.bash_profile.

Zsh note: Modify your ~/.zshrc file instead of ~/.bash_profile.

Credits

homework is significantly inspired by npm.