Skip to content

Commit b3ad658

Browse files
committed
Make README useful.
1 parent d56be7f commit b3ad658

File tree

1 file changed

+5
-28
lines changed

1 file changed

+5
-28
lines changed

README.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,13 @@
1-
# Scelint
1+
# `scelint`
22

3-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/scelint`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
6-
7-
## Installation
8-
9-
Add this line to your application's Gemfile:
10-
11-
```ruby
12-
gem 'scelint'
13-
```
14-
15-
And then execute:
16-
17-
$ bundle install
18-
19-
Or install it yourself as:
20-
21-
$ gem install scelint
3+
Lint SIMP Compliance Engine data.
224

235
## Usage
246

25-
TODO: Write usage instructions here
26-
27-
## Development
28-
29-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30-
31-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
7+
With no arguments, the included `scelint` script will look for SCE data in the standard load path (`SIMP/compliance_profiles`) under the current directory.
8+
Alternatively, any file arguments specified will be loaded directly. Any directory arguments will be searched under the standard load path.
329

3310
## Contributing
3411

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scelint.
12+
Bug reports and pull requests are welcome on GitHub at https://github.com/silug/rubygem-simp-scelint.
3613

0 commit comments

Comments
 (0)