command-line-cleanup #59

Merged
sloum merged 7 commits from asdf/bombadillo:command-line-cleanup into develop 2019-10-24 01:57:24 +00:00
Collaborator

This change is meant to be completed after the makefile branch is merged in.

The PR contains small enhancements for the command line options -h and -v and associated documentation.

Some wording may be unified in multiple areas, such as the subtitle "a non-web client" being added after the title "Bombadillo".

This change is meant to be completed after the makefile branch is merged in. The PR contains small enhancements for the command line options `-h` and `-v` and associated documentation. Some wording may be unified in multiple areas, such as the subtitle "a non-web client" being added after the title "Bombadillo".
asdf self-assigned this 2019-10-22 04:06:21 +00:00
sloum was assigned by asdf 2019-10-22 04:06:21 +00:00
asdf added the
enhancement
non-functional
non-urgent
labels 2019-10-22 04:06:21 +00:00
Author
Collaborator

(hoping this can be merged after makefile branch with no issues...)

I don't know if there is much else to change for this PR. Let me know if any suggestions or issues.

(hoping this can be merged after makefile branch with no issues...) I don't know if there is much else to change for this PR. Let me know if any suggestions or issues.
sloum approved these changes 2019-10-22 05:29:50 +00:00
sloum left a comment
Owner

Looks good. A couple small things, but otherwise approved.

Looks good. A couple small things, but otherwise approved.
@ -21,3 +21,3 @@
git clone https://tildegit.org/sloum/bombadillo.git
cd bombadillo
go install
sudo make install
Owner

This should be:

git clone https://tildegit.org/sloum/bombadillo.git && cd bombadillo
make
sudo make install
This should be: ``` git clone https://tildegit.org/sloum/bombadillo.git && cd bombadillo make sudo make install ```
@ -32,3 +44,3 @@
#### Troubleshooting
If you run `bombadillo` and get `bombadillo: command not found`, try running `go build` from within the cloned repo. Then try: `./bombadillo`. If that works it means that Go does not install to your path. `go build` added an executable file to the repo directory. Move that file to somewhere on your path. I suggest `/usr/local/bin` on most systems, but that may be a matter of personal preference.
If you run `bombadillo` and get `bombadillo: command not found`, try running `make` from within the cloned repository. Next, try: `./bombadillo`. If this works, it means that the installation was not completed to an area in your `PATH`.
Owner

I'm not sure that this is still relevant. They should be running make as part of the initial install anyway. The path part is still relevant for sure.

Do we want to mention that the standard go commands of build and install are also still valid options for installing the program, but that they are not recommended as they will not also isntall the documentation? Or should we just leave that to people to figure out on their own?

I'm not sure that this is still relevant. They should be running make as part of the initial install anyway. The path part is still relevant for sure. Do we want to mention that the standard go commands of `build` and `install` are also still valid options for installing the program, but that they are not recommended as they will not also isntall the documentation? Or should we just leave that to people to figure out on their own?
asdf added the
blocked
label 2019-10-23 02:35:54 +00:00
Author
Collaborator

Waiting on #57 before further action is taken.

Waiting on #57 before further action is taken.
asdf removed the
blocked
label 2019-10-24 01:16:56 +00:00
Author
Collaborator

The changes specific to this PR are now easily visible. Please note that the commits were duplicated because I had to rebase.

The changes specific to this PR are now easily visible. Please note that the commits were duplicated because I had to rebase.
sloum approved these changes 2019-10-24 01:56:40 +00:00
sloum left a comment
Owner

This looks good. I approve. I think the change in the readme may need to get shifted up a bit depending on how the remaining open PR goes, but I think we are good to go merging this in.

This looks good. I approve. I think the change in the readme may need to get shifted up a bit depending on how the remaining open PR goes, but I think we are good to go merging this in.
Owner

Merging in :)

Merging in :)
sloum closed this pull request 2019-10-24 01:57:23 +00:00
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: sloum/bombadillo#59
No description provided.