https://github.com/chances/sandwiches
A Makefile creation and management utility for any project
https://github.com/chances/sandwiches
Last synced: 8 months ago
JSON representation
A Makefile creation and management utility for any project
- Host: GitHub
- URL: https://github.com/chances/sandwiches
- Owner: chances
- License: mit
- Created: 2015-02-16T19:56:17.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-04-05T10:40:21.000Z (about 8 years ago)
- Last Synced: 2025-02-09T23:02:38.624Z (over 1 year ago)
- Language: TypeScript
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sandwiches
A Makefile creation and management utility for any project.
*WARNING:* This utility is **not** ready for use in the wild.
[![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![NPM Dependencies][deps-image]][deps-url] ![Maintenance Status][maintain-image]
## Installation
```sh
$ npm install --global sandwiches
```
## Make a sandwich
Quickly prepare a Makefile specifically suited to your your project's tastes
using Sandwiches. To create a basic Makefile, run the following:
```sh
$ sandwich make
```
For more help, run:
```sh
$ sandwich help
```
TODO: Fully describe the CLI utility instead of directing people to the help
command.
## Make a recipe
Using the Sandwiches API, you can create new recipes to be followed when
making new or modifying existing Makefiles.
### Doesn't a sandwich have toppings?
Yes, it does!
TODO: Design what sandwich toppings should exactly be. Something like mixins?
## How do I make a sandwich?
TODO: Create more documentation when the code reflects a need. (Soon)
## License
[![License][license-image]][license-url]
Copyright © 2015 Chance Snow
[npm-url]: https://npmjs.org/package/sandwiches
[npm-image]: https://badge.fury.io/js/sandwiches.svg
[travis-url]: https://travis-ci.org/chances/sandwiches
[travis-image]: http://img.shields.io/travis/chances/sandwiches.svg
[deps-url]: https://david-dm.org/chances/sandwiches
[deps-image]: https://img.shields.io/david/chances/sandwiches.svg
[deps-dev-url]: https://david-dm.org/chances/sandwiches#info=devDependencies
[deps-dev-image]: https://img.shields.io/david/dev/chances/sandwiches.svg
[maintain-image]: https://img.shields.io/maintenance/yes/2015.svg
[license-url]: https://github.com/chances/sandwiches/blob/master/LICENSE
[license-image]: https://img.shields.io/npm/l/sandwiches.svg