Blame view

README.md 1.71 KB
31f9a345   Isaac Lewis   init; some tests
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
  # Syspro
  
  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/syspro`. To experiment with that code, run `bin/console` for an interactive prompt.
  
  TODO: Delete this and the text above, and describe your gem
  
  ## Installation
  
  Add this line to your application's Gemfile:
  
  ```ruby
  gem 'syspro'
  ```
  
  And then execute:
  
      $ bundle
  
  Or install it yourself as:
  
      $ gem install syspro
  
  ## Usage
  
  TODO: Write usage instructions here
  
  ## Development
  
  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.
  
  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).
  
  ## Contributing
  
  Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/syspro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
  
  ## License
  
  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
  
  ## Code of Conduct
  
  Everyone interacting in the Syspro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/syspro/blob/master/CODE_OF_CONDUCT.md).