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

Readme tweaks #1

Merged
merged 1 commit into from
Jan 21, 2019
Merged

Readme tweaks #1

merged 1 commit into from
Jan 21, 2019

Conversation

macMikey
Copy link
Contributor

  • Add instructions for including the helper, including submoduling, ad modifying app.yml
  • Fix typos
  • Made the example a mouseup handler since it's an example.

@macMikey macMikey mentioned this pull request Jan 19, 2019
README.md Outdated
- folder: ./helpers
- filename: "[[FRAMEWORK]]/helpers/levurehelper-file_browser"
- filename: "[[FRAMEWORK]]/helpers/levurehelper-dataview"
- filename: "[[FRAMEWORK]]/helpers/levurehelper-dataview_tree"
Copy link
Owner

Choose a reason for hiding this comment

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

@macMikey These helper paths are incorrect as the helpers are not distributed with the Levure framework. You don't need to modify the app.yml file at all since the helpers are added to the ./app/helpers folder. The default app.yml file includes all helpers in the ./app/helpers folder.

@macMikey
Copy link
Contributor Author

I don't have helpers specifically called out in app.yml for the heck of it. What the heck was the problem we ran into if we did just ./helpers? I can't remember what it was off the top, but the way to fix it was to specify the helpers individually, I thought. I have the preferences, logger, error handler, etc. all called out specifically because of whatever the issue was.

@trevordevore
Copy link
Owner

I don't recall a problem with just using ./helpers. preferences and logger are helpers that come with Levure. They require the [[FRAMEWORK]]/helpers/ syntax. You probably list them separately because you don't want to load all of the helpers that come with Levure. For the app it makes sense to just use ./helpers because any helper you place in there you intend on using in your app.

@macMikey
Copy link
Contributor Author

Oh FRICK I realized that I had ```[[FRAMEWORK]] in the readme. #FALE

@macMikey macMikey force-pushed the master branch 2 times, most recently from 92389b1 to 9950bfe Compare January 20, 2019 05:34
@macMikey
Copy link
Contributor Author

Have a look at that.

README.md Outdated
To include the File Browser Dataview control in your project (using git):
1. Submodule the File Browser Dataview control https://github.com/trevordevore/levurehelper-file_browser to app/helpers/levurehelper-file_browser
2. Submodule the DataView helper https://github.com/trevordevore/levurehelper-dataview to app/helpers/levurehelper-dataview
3. Submodule the DataView Tree helper https://github.com/trevordevore/levurehelper-dataview_tree to app/helpers/levurehelper-dataview-tree
Copy link
Owner

Choose a reason for hiding this comment

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

@macMikey I would recommend that the submodule folder names strip out levurehelper-. For example, app/helpers/dataview-tree. I use levurehelper- as prefixes on the repo names but within the app itself I like to strip it out because it looks nicer.

* Add instructions for including the helper, including submoduling, ad modifying app.yml
* Fix typos
* Made the example a ```mouseup``` handler since it's an example.
@macMikey
Copy link
Contributor Author

better?

@trevordevore trevordevore merged commit 9034d2e into trevordevore:master Jan 21, 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.

None yet

2 participants