Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve developer instructions in README #51

Merged
merged 1 commit into from
Nov 20, 2019
Merged

Conversation

mkasberg
Copy link
Contributor

When I started working on a few minor contributions last month, it was
not obvious to me how it should be run. I tried a couple things:

$ ./bin/calendariumrom
Traceback (most recent call last):
	2: from ./bin/calendariumrom:3:in `<main>'
	1: from /usr/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
/usr/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require': cannot load such file -- calendarium-romanum (LoadError)

$ bundle exec bin/calendariumrom
bundler: failed to load command: bin/calendariumrom (bin/calendariumrom)
LoadError: cannot load such file -- calendarium-romanum
  bin/calendariumrom:3:in `require'
  bin/calendariumrom:3:in `<top (required)>'

Unfortunately, these all resulted in errors. The solution is to run with
-Ilib:

$ bundle exec ruby -Ilib bin/calendariumrom
Commands:
  calendariumrom calendars          # lists calendars available for querying

This commit adds some instructions to the README so developers know how
to do this if they want to run calendariumrom from the source code.

When I started working on a few minor contributions last month, it was
not obvious to me how it should be run. I tried a couple things:

    $ ./bin/calendariumrom
    Traceback (most recent call last):
    	2: from ./bin/calendariumrom:3:in `<main>'
    	1: from /usr/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
    /usr/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require': cannot load such file -- calendarium-romanum (LoadError)

    $ bundle exec bin/calendariumrom
    bundler: failed to load command: bin/calendariumrom (bin/calendariumrom)
    LoadError: cannot load such file -- calendarium-romanum
      bin/calendariumrom:3:in `require'
      bin/calendariumrom:3:in `<top (required)>'

Unfortunately, these all resulted in errors. The solution is to run with
`-Ilib`:

    $ bundle exec ruby -Ilib bin/calendariumrom
    Commands:
      calendariumrom calendars          # lists calendars available for querying

This commit adds some instructions to the README so developers know how
to do this if they want to run calendariumrom from the source code.
@igneus
Copy link
Owner

igneus commented Nov 20, 2019

Thanks, merging. (And I'm sorry I haven't decided on related issue #45 yet.)

@igneus igneus merged commit cbe630b into igneus:master Nov 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants