As a user, I would like a detailed README #5

New Issue

sloum · 2019-05-02T02:19:36Z

sloum commented

2019-05-02 02:19:36 +00:00

Bombadillo does not currently have a readme. One can be written combining build/install instructions as well as the user help manual that can be found via the :help command inside bombadillo.

Bombadillo does not currently have a readme. One can be written combining build/install instructions as well as the user help manual that can be found via the `:help` command inside bombadillo.

sloum added the

non-code

label 2019-05-02 02:19:36 +00:00

sloum changed title from ~~README needed~~ to As a user, I would like a detailed README

2019-05-14 20:10:56 +00:00

asdf commented

2019-05-26 10:18:31 +00:00

You have a really good document for Bombadillo published at rawtext club. Do you have that in markdown or just HTML?

sloum commented

2019-05-26 15:50:07 +00:00

Just html. I plan on converting most of it. Either that or focusing the README.md on how to build and install Bombadillo, linking out for more than the quickstart.

What do you think? Should I just duplicate the content in full here? Or link out to it, providing a subset here?

Just html. I plan on converting most of it. Either that or focusing the README.md on how to build and install Bombadillo, linking out for more than the quickstart. What do you think? Should I just duplicate the content in full here? Or link out to it, providing a subset here?

sloum commented

2019-05-26 17:56:35 +00:00

Closed by #21

I went fairly simple: focused on getting the program up and running. The readme does link out to the documentation hosted on rawtext.club as well as discusses the built in docs that load when Bombadillo is run, as well as how to get to them if one navigates away.

I think the focus on building/installation is suitable for the venue of a source code repo and hope it will suffice to get most users up and running.

I also linked out to the downloads section of the rawtext.club page so that users that do not run go, or possibly do not know how to do so, can still get the application.

@asdf ff you see anything you think should be changed/updated please let me know!

Closed by https://tildegit.org/sloum/bombadillo/pulls/21 I went fairly simple: focused on getting the program up and running. The readme does link out to the documentation hosted on rawtext.club as well as discusses the built in docs that load when Bombadillo is run, as well as how to get to them if one navigates away. I think the focus on building/installation is suitable for the venue of a source code repo and hope it will suffice to get most users up and running. I also linked out to the downloads section of the rawtext.club page so that users that do not run go, or possibly do not know how to do so, can still get the application. @asdf ff you see anything you think should be changed/updated please let me know!

sloum closed this issue

2019-05-26 17:56:36 +00:00

Sign in to join this conversation.