github/diceware
1
0
Fork 0
mirror of https://github.com/dmuth/diceware.git synced 2024-11-21 16:36:28 -05:00
Code Issues Projects Releases Packages Wiki Activity

Added development section.

Browse source
This commit is contained in:
Douglas Muth 2017-11-08 23:44:16 -05:00
parent c1e52faeb7
commit 02ff5cfb9c
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -19,6 +19,9 @@ For more information on Diceware:
Yes. Feel free to clone this repo with `git clone https://github.com/dmuth/diceware.git` and run it Yes. Feel free to clone this repo with `git clone https://github.com/dmuth/diceware.git` and run it
from a local directory on your computer. from a local directory on your computer.
You can also set up a webserver on Mac/Linux boxes by running `python -m SimpleHTTPServer 8000`.
You will then able to access DiceWare at http://localhost:8000/.
# Will this work on an iPhone? # Will this work on an iPhone?
@ -26,6 +29,18 @@ Yep! It should work on any mobile phone or tablet that supports Javascript, but
tested it on an iPhone 5S at this time. tested it on an iPhone 5S at this time.
# Development
This app is built with <a href="https://webpack.js.org/">Webpack</a>.
When done editing `main.js`, the packed file can be built by simply running `webpack` on the command line.
It will be writting to `dist/bundle.js`.
In a move that departs from Best Practices, I have made the decision to include the packed file in Git.
My reason for this is that the software will be ready to run as soon as it is checked out (or a ZIP is downloaded),
and that is a key design feature of this app--I want it to be as easy to get up and running as possible.
# Who built this? / Contact # Who built this? / Contact
My name is Douglas Muth, and I am a software engineer in Philadelphia, PA. My name is Douglas Muth, and I am a software engineer in Philadelphia, PA.