?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 2.41 KB

/proc/thread-self/root/opt/alt/ruby31/share/gems/gems/bundler-2.3.27/lib/bundler/templates/newgem/README.md.tt

Text Base64

# <%= config[:constant_name] %>

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/<%= config[:namespaced_path] %>`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add <%= config[:name] %>

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install <%= config[:name] %>

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies.<% if config[:test] %> Then, run `rake <%= config[:test].sub('mini', '').sub('rspec', 'spec') %>` to run the tests.<% end %> You can also run `bin/console` for an interactive prompt that will allow you to experiment.<% if config[:bin] %> Run `bundle exec <%= config[:name] %>` to use the gem in this directory, ignoring other installed copies of this gem.<% end %>

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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
<% if config[:git] -%>

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/<%= config[:github_username] %>/<%= config[:name] %>.<% if config[:coc] %> This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/<%= config[:github_username] %>/<%= config[:name] %>/blob/<%= config[:git_default_branch] %>/CODE_OF_CONDUCT.md).<% end %>
<% end -%>
<% if config[:mit] -%>

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
<% end -%>
<% if config[:git] && config[:coc] -%>

## Code of Conduct

Everyone interacting in the <%= config[:constant_name] %> project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<%= config[:github_username] %>/<%= config[:name] %>/blob/<%= config[:git_default_branch] %>/CODE_OF_CONDUCT.md).
<% end -%>

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
bin DIR	-	drwxr-xr-x	2025-05-13 07:35:07	Edit Download recursive recursive
circleci DIR	-	drwxr-xr-x	2025-05-13 07:35:07	Edit Download recursive recursive
exe DIR	-	drwxr-xr-x	2025-05-13 07:35:07	Edit Download recursive recursive
ext DIR	-	drwxr-xr-x	2025-04-28 17:36:04	Edit Download recursive recursive
github DIR	-	drwxr-xr-x	2025-04-28 17:36:04	Edit Download recursive recursive
lib DIR	-	drwxr-xr-x	2025-05-13 07:35:07	Edit Download recursive recursive
sig DIR	-	drwxr-xr-x	2025-05-13 07:35:07	Edit Download recursive recursive
spec DIR	-	drwxr-xr-x	2025-05-13 07:35:07	Edit Download recursive recursive
test DIR	-	drwxr-xr-x	2025-04-28 17:36:04	Edit Download recursive recursive
CHANGELOG.md.tt	80 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
CODE_OF_CONDUCT.md.tt	5.10 KB	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
Gemfile.tt	527 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
gitignore.tt	228 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
gitlab-ci.yml.tt	182 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
LICENSE.txt.tt	1.08 KB	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
newgem.gemspec.tt	1.79 KB	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
Rakefile.tt	1.24 KB	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
README.md.tt	2.41 KB	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
rspec.tt	53 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
rubocop.yml.tt	299 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
standard.yml.tt	184 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive
travis.yml.tt	126 B	lrw-r--r--	2025-04-28 17:36:06	Edit Download recursive recursive

Directory Contents