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

Rewrote your local build instructions! #3201

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

NuclearMachine
Copy link

Hey! Thought your local build instructions could use some help. It's bloated and filled with sections that could lead to errors. It's also missing a bunch of pre-requisites which might derail newcomers.

  • The recommended version isn't listed anywhere (2.7.6). The application or rails console will not start if the ruby version is v3 and above (NameError: uninitialized class variable @@schemes in URI).
  • Most users will encounter a mimemagic build error while bundling and there are no notes for this.
  • Prepending DATABASE_ADAPTER=postgresql in every shell command is unnecessary. The user should update this variable directly from the .env file along with the DB username and password. Also, if the user prepends the command and disregards updating .env, the application will fail to start as .env defaults to mysql.
  • There should be a section for updating the database username and password for .env.

I've simplified the local build instructions. Let me know what you guys think!

I believe these changes will help your users especially newbies who might be looking to use Huginn!

@NuclearMachine
Copy link
Author

I also suggest that you guys add a .ruby-version for managers like rbenv to auto-set the ruby version.

Copy link
Collaborator

@virtadpt virtadpt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks great to me. The new isntructions definitely line up with my own notes.

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.

None yet

2 participants