Refactor the application to use git mod, repo structure #9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit rewrites the README for this project. The author has been going back and fourth between whether to try and find a replacement for this project or not; cookiecutter being the most promising alternative. However, the ease of installation and use of this project is extremely compelling. Given this, the author is choosing instead to take on some level of burden to fix its shortcomings, rather than attempt to redo things in another tool. Further, this tool is written in the go language -- one of the primary languages of LMC.
Currently the repositiory is using "glide" for go version dependency. The standard with more recent go projects is "go module". This commit modifies the project to use the go module style. == Design Notes === Package Name Because the package is to be maintained by littleman.co going forward, it uses the littleman.co package name spec. === Renaming the project This commit also continues the project of renaming the project "boilr" → "oilr". Future work will continue this process as references to boilr become more apparent.
Currently there is a problem with boilr in that it does not allow the double hyphen (--) in the path name. This pattern is useful in GitHub to simulate a directory path where GitHub otherwise does not allow one.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Source: littlemanco@d931e0a
Currently the repositiory is using "glide" for go version dependency.
The standard with more recent go projects is "go module".
This commit modifies the project to use the go module style.
== Design Notes
=== Package Name
Because the package is to be maintained by littleman.co going forward,
it uses the littleman.co package name spec.
=== Renaming the project
This commit also continues the project of renaming the project "boilr" →
"oilr". Future work will continue this process as references to boilr
become more apparent.