Move lib-related docs to main lib file #46
Merged
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
In order to install the `tracker` command, one needs to install the library (i.e. `App::TimeTracker`), therefore the installation instructions should rather be as part of the library documentation and not as part of the `tracker` binary documentation. See also GitHub issue domm#40 for further discussion around this topic.
... as this is a more logical place for this information than in the documentation for the `tracker` command.
... that they are more readily accessible for users wanting to know how to use the `tracker` program. The more general CONFIGURATION section has thus been moved down as it is not as relevant for new users.
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.
As mentioned in #40, some of the documentation would be better placed in the main library file (i.e. the place where the docs about the backend are) than in the documentation of the
trackerprogram. This patch moves the documentation around a bit so that information about such things as installation, how to get the source code etc. are now placed in the module (i.e. lib) documentation, whereas more focus is put on the usage documentation within thetrackerprogram. Hopefully now usage information for thetrackerprogram is easier for new users to find.