Provide more info in README in rewrite branch
frankhale opened this issue · 2 comments
The way you run Toby in the rewrite branch is a bit different in that if you build it and run it using 'npm start' it just starts the Express server. You need a client to interact, either a browser or Electron or NW.js. The server starts on the default Express port (3000) for now.
The clients directory has both Electron and a NW.js apps but there are no directions on how to use them. They assume you understand Electron and/or NW.js.
This is all kind of problematic right now because it makes creating a distribution more difficult because there is no direct support to just instantiate Electron and/or NW.js and run everything necessary to run Toby.
I don't want to go off on a tangent here. Suffice it to say the README needs to be updated with necessary information.
Reference: #68
So now that the challenges of distributing at least for NW.js have been solved (at least the major parts) I can now fill in the blanks for how to sanely run the rewrite branch and not be like "THIS IS STUPID!".
Will try to have the README more detailed in next few days as the dust settles.
Closing, README has been updated in rewrite branch and will continue to receive updates as info settles down.