Skip to content

Commit d441115

Browse files
committed
docs: README, LICENSE
1 parent 103cbd6 commit d441115

File tree

2 files changed

+39
-19
lines changed

2 files changed

+39
-19
lines changed

Diff for: LICENSE.txt

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Copyright (c) 2023 ongaeshi
2+
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the
5+
"Software"), to deal in the Software without restriction, including
6+
without limitation the rights to use, copy, modify, merge, publish,
7+
distribute, sublicense, and/or sell copies of the Software, and to
8+
permit persons to whom the Software is furnished to do so, subject to
9+
the following conditions:
10+
11+
The above copyright notice and this permission notice shall be
12+
included in all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# Runa
22

3-
TODO: Delete this and the text below, and describe your gem
3+
Runa is a command line interface for easily creating Ruby applications.
44

5-
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/runa`. To experiment with that code, run `bin/console` for an interactive prompt.
5+
## Install
66

7-
## Installation
8-
9-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
10-
11-
Install the gem and add to the application's Gemfile by executing:
12-
13-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
14-
15-
If bundler is not being used to manage dependencies, install the gem by executing:
16-
17-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
7+
```
8+
$ gem install runa
9+
```
1810

1911
## Usage
2012

21-
TODO: Write usage instructions here
13+
Create a new application.
2214

23-
## Development
15+
```
16+
$ runa new runa_app
17+
$ cd runa_app
18+
```
2419

25-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
20+
If you need a gem, Write it in the `Gemfile`.
2621

27-
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).
22+
```
23+
$ code Gemfile
24+
$ runa install
25+
```
2826

29-
## Contributing
27+
Run application.
3028

31-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/runa.
29+
```
30+
$ runa run
31+
```

0 commit comments

Comments
 (0)