You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generate an appveyor.yml file to the cwd or specified directory. Install globally and run with generate's CLI, or use as a component in your own generator.
4
9
5
-
You might also be interested in [generate-travis](https://github.com/generate/generate-travis).
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md). Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.
14
+
You might also be interested in [generate-travis](https://github.com/generate/generate-travis).
10
15
11
-
For more information about Generate:
12
-
13
-
* Visit the [generate project](https://github.com/generate/generate)
14
-
* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)
15
-
* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))
@@ -62,24 +63,50 @@ Alias to enable running the [appveyor](#appveyor) task with the following comman
62
63
$ gen appveyor
63
64
```
64
65
65
-
## CLI
66
+
## What is "Generate"?
67
+
68
+
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).
69
+
70
+
Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.
71
+
72
+
**For more information**:
73
+
74
+
* Visit the [generate project](https://github.com/generate/generate/)
75
+
* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)
76
+
* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))
77
+
78
+
## Getting started
79
+
80
+
### Install
81
+
82
+
**Installing the CLI**
83
+
84
+
To run the `appveyor` generator from the command line, you'll need to install [Generate](https://github.com/generate/generate) globally first. You can do that now with the following command:
85
+
86
+
```sh
87
+
$ npm install --global generate
88
+
```
89
+
90
+
This adds the `gen` command to your system path, allowing it to be run from any directory.
66
91
67
-
**Help**
92
+
**Install generate-appveyor**
68
93
69
-
Get general help and a menu of available commands:
94
+
Install this module with the following command:
70
95
71
96
```sh
72
-
$ gen help
97
+
$ npm install --global generate-appveyor
73
98
```
74
99
75
-
**Running the `appveyor` generator**
100
+
### Usage
76
101
77
-
Once both [generate](https://github.com/generate/generate) and `generate-appveyor` are installed globally, you can run the generator with the following command:
102
+
Run this generator's `default`[task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:
78
103
79
104
```sh
80
105
$ gen appveyor
81
106
```
82
107
108
+
**What you should see in the terminal**
109
+
83
110
If completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:
84
111
85
112
```sh
@@ -90,42 +117,61 @@ If completed successfully, you should see both `starting` and `finished` events
90
117
91
118
If you do not see one or both of those events, please [let us know about it](../../issues).
92
119
93
-
## API
120
+
### Help
121
+
122
+
To see a general help menu and available commands for Generate's CLI, run:
123
+
124
+
```sh
125
+
$ gen help
126
+
```
127
+
128
+
## Tasks
94
129
95
-
### Install locally
130
+
All available tasks.
96
131
97
-
If you want to use `generate-appveyor` as a plugin or sub-generator to extend the features and settings in your own generator, you must first install it locally:
132
+
### [appveyor:appveyor](generator.js#L20)
98
133
99
-
Install with [npm](https://www.npmjs.com/):
134
+
Generates an `appveyor.yml` file in the current working directory.
135
+
136
+
**Example**
100
137
101
138
```sh
102
-
$ npm install --save generate-appveyor
139
+
$ gen appveyor:appveyor
103
140
```
104
141
105
-
### Use as a plugin
142
+
### [appveyor:default](generator.js#L35)
106
143
107
-
Use as a [plugin](https://github.com/generate/generate/blob/master/docs/plugins.md) if you want to extend your own generator with the features, settings and tasks of `generate-appveyor`, as if they were created on your generator:
144
+
Alias to enable running the [appveyor](#appveyor) task with the following command:
108
145
109
-
```js
110
-
module.exports=function(app) {
111
-
app.use(require('generate-appveyor'));
112
-
};
146
+
**Example**
147
+
148
+
```sh
149
+
$ gen appveyor
113
150
```
114
151
115
-
Visit Generate's [plugin docs](https://github.com/generate/generate/blob/master/docs/plugins.md) to learn more about plugins.
152
+
Visit Generate's [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).
116
153
117
-
### Use as a sub-generator
154
+
##Next steps
118
155
119
-
Use as a [sub-generator](https://github.com/generate/generate/blob/master/docs/generators.md) if you want to add `generate-appveyor` to a _namespace_ in your generator:
156
+
### Running unit tests
120
157
121
-
```js
122
-
module.exports=function(app) {
123
-
// register the generate-appveyor with whatever name you want
It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:
159
+
160
+
```sh
161
+
$ npm install &&test
126
162
```
127
163
128
-
Visit Generate's [sub-generator docs](https://github.com/generate/generate/blob/master/docs/sub-generators.md) to learn more about sub-generators.
164
+
### Publishing your generator
165
+
166
+
If you're tests are passing and you're ready to publish your generator to [npm](https://www.npmjs.com), you can do that now with the following command:
*[generate-travis](https://www.npmjs.com/package/generate-travis): Generate a .travis.yml file to the cwd or specified directory. Install globally and run with… [more](https://github.com/generate/generate-travis) | [homepage](https://github.com/generate/generate-travis"Generate a .travis.yml file to the cwd or specified directory. Install globally and run with generate's CLI, or use as a component in your own generator.")
137
183
*[generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate"Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.")
138
184
139
-
### Contributing
185
+
### Community
140
186
141
-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
187
+
Are you using [Generate](https://github.com/generate/generate) in your project? Have you published a [generator](https://github.com/generate/generate/blob/master/docs/generators.md) and want to share your project with the world?
142
188
143
-
### Building docs
189
+
Here are some suggestions!
144
190
145
-
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
191
+
* If you get like Generate and want to tweet about it, please feel free to mention `@generatejs` or use the `#generatejs` hashtag
192
+
* Show your love by starring [Generate](https://github.com/generate/generate) and `generate-appveyor`
193
+
* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) (please use the `generatejs` tag in questions)
194
+
***Gitter** Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)
195
+
* If you publish an generator, thank you! To make your project as discoverable as possible, please add the keyword `generategenerator` to package.json.
146
196
147
-
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
0 commit comments