Compare commits
No commits in common. 'master' and 'bfecfd17401c541aeb36e408e64898d0fc421a0c' have entirely different histories.
master
...
bfecfd1740
@ -1,39 +1,17 @@ |
||||
# AgendaPdf |
||||
# Agenda PDF |
||||
|
||||
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/agenda_pdf`. To experiment with that code, run `bin/console` for an interactive prompt. |
||||
## Purpose |
||||
On the [Remarkable](https://remarkable.com/) you can use a PDF as a template. This will fill the blank page with the content of the PDF and you can write over it. |
||||
|
||||
TODO: Delete this and the text above, and describe your gem |
||||
My wife loves to do her agenda on the Remarkable; so I created this gem so she can have a tool to do it alone whenever she wants. |
||||
|
||||
## Installation |
||||
|
||||
Add this line to your application's Gemfile: |
||||
|
||||
```ruby |
||||
gem 'agenda_pdf' |
||||
``` |
||||
|
||||
And then execute: |
||||
|
||||
$ bundle |
||||
|
||||
Or install it yourself as: |
||||
|
||||
$ gem install agenda_pdf |
||||
## Setup |
||||
- Install ruby 3.0.2 |
||||
- `bundle install` |
||||
|
||||
## Usage |
||||
`bundle exec agenda_pdf -m <yyyy-mm-dd> -o <output_file>.pdf` |
||||
|
||||
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]/agenda_pdf. |
||||
|
||||
## License |
||||
Example: |
||||
|
||||
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). |
||||
`bundle exec agenda_pdf -m 2023-08-21 -o test.pdf` |
||||
|
||||
@ -1,3 +1,3 @@ |
||||
module AgendaPdf |
||||
VERSION = "0.1.0" |
||||
VERSION = "0.1.1" |
||||
end |
||||
|
||||
Loading…
Reference in new issue