WIP first go at updating the readme #70
No reviewers
Labels
No Label
blocked
bug
build
documentation
duplicate
enhancement
finger
gemini
gopher
help wanted
http
in progress
invalid
local
needs-info
non-code
non-functional
non-urgent
question
release
rendering
suggestion
telnet
terminal
urgent
wontfix
No Milestone
2 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sloum/bombadillo#70
Loading…
Reference in New Issue
No description provided.
Delete Branch "update-readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
We've both done work on
README.md
and there are enough changes to warrant merging this in.There are some parts I would like some clarification on that I'll mark for review.
Which setting can't be changed within Bombadillo?
(I assume you can see the message I've left on line 56 asking which option cannot be set within bombadillo?)
configlocation
. This is due tot he fact that when bombadillo loads, it always loads the defaults first. Then checksconfiglocation
and loads the user config. This cannot be set within bombadillo, because it will always use whatever is in the default (which can be set at compile time).This is really great! You have a much better way with words for stuff like this than I seem to. I'm really happy with it, in particular the section on contributions to the project.
It seems there are merge conflicts into develop, but aside from getting those solved I definitely approve this to get merged in. :)
@ -4,0 +14,4 @@
* http/https
* Web support is opt-in (turned off by default)
* Links can be opened in a user's default web browser when in a graphical environment
* Web pages can be rendered directly in Bombadillo if [Lynx](https://lynx.invisible-island.net/) is installed on the system to handle the document parsing.
This is probably my bad, but the period should be removed from the end of this. None of the other list items end in a period.
@ -50,1 +105,3 @@
## Contributing
- Try out the client and let us know if you have a suggestion for improvement, or if you find a bug.
- Read the documentation and let us know if something isn't well explained, or needs correction.
- Maybe you have a cool logo or some art that you think would look nice.
This whole list and the leadin text above is really great. Well put!
@ -52,1 +109,3 @@
Bombadillo development is largely handled by Sloum, with help from jboverf, asdf, and some community input. If you would like to get involved, please reach out or submit an issue. At present the developers use the tildegit issues system to discuss new features, track bugs, and communicate with users about hopes and/or issues for/with the software. If you have forked and would like to make a pull request, please make the pull request into `develop` where it will be reviewed by one of the maintainers. That said, a heads up or comment/issue somewhere is advised.
If you have something in mind, please reach out or [open an issue](https://tildegit.org/sloum/bombadillo/issues).
We aim for simplicity and quality, and do our best to make Bombadillo useful to its users. Any proposals for change are reviewed by the maintainers with this in mind, and not every request will be accepted. Furthermore, this software is developed in our spare time for the good of all, and help is provided as best efforts. In general, we want to help!
Yeah, this. Much more eloquent than what I had. Thanks!
Fixed merge conflict, made further changes to the opening paragraphs/lists, as well as the Custom Installation section.
I'm going to merge this in now, but let me know if there is something you would like changed. This can wait until just before the 2.0.0 launch.