reconftw icon indicating copy to clipboard operation
reconftw copied to clipboard

Improve wiki/readme

Open six2dez opened this issue 3 years ago • 4 comments

  • Full docs revision
  • Add example scenarios to wiki
  • Desired tech requirements

six2dez avatar Jan 20 '22 22:01 six2dez

I have devised a way to (very simply) configure the Docker Image as an axiom controller. Would you mind having a look at the readme here & letting me know if this is something you'd like to incorporate?

If so then I'll fork & make a PR.

frost19k avatar Apr 04 '22 16:04 frost19k

Yeah sure!

six2dez avatar Apr 08 '22 14:04 six2dez

Okay, the changes are ready for PR.

We now have 3 option under Docker & the instructions are rather long. So I moved all but the basic instructions to the Wiki - rewriting that page entirely.

You can have a look at the new wiki page here

My PR will not include the Wiki - limitations of GitHub. How would you like to handle this?

Also, of course, inputs & criticisms of the new wiki - if you have any.

frost19k avatar Apr 12 '22 16:04 frost19k

I can update the Wiki right now and you can do a PR for the README.md by adding a reference to the wiki in the Docker section. If this works for you, just create the PR and I will accept and update the wiki at the same time. Remember to do PR to dev branch

six2dez avatar Apr 12 '22 17:04 six2dez