This Rug archive contains My new project
After you create a project with this generator, you may enjoy the compatible editors in russmiles:rug-editors.
The AddReadme editor adds a GitHub-like README.md to a project.
Before running this editor, you must have the following prerequisites satisfied.
- A source code repository
To run this editor, you must supply the following parameters.
| Name | Required | Default | Description |
|---|---|---|---|
project_name |
Yes | A valid GitHub repository name. | |
description |
No | My new project | A brief description of the project between 1 and 100 characters. |
Run it as follows:
$ cd to/the/repo
$ rug edit russmiles:copedemoarch:AddReadme \
project_name=fun-project \
description='A project that needs a README'
This will create a simple README.md file in the top-level directory
of the source code repository. If you are happy with the change,
commit the changes.
General support questions should be discussed in the #support
channel on our community Slack team
at atomist-community.slack.com.
If you find a problem, please create an issue.
You can build, test, and install the project locally with the Rug CLI.
$ rug test
$ rug install
To create a new release of the project, simply push a tag of the form
M.N.P where M, N, and P are integers that form the next
appropriate semantic version for release. For example:
$ git tag -a 1.2.3
The Travis CI build (see badge at the top of this page) will automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes. It will also automatically upload the needed artifacts.
Created by Atomist. Need Help? Join our Slack team.