Kris Lamoureux
abeffc5fc2
loadlist() will now return a dictionary of the word list when successfully loaded and None on failure. The unnecessary main script was removed and core.py took it's place. Wording was further changed from "password" to "passphrase."
43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
# Dicekey
|
|
|
|
Dicekey is a [Diceware](http://diceware.com) passphrase generator that aims
|
|
to be user friendly and encourage the adoption of strong random passphrases.
|
|
|
|
## Quick Start
|
|
|
|
Instructions on how to install from the git repository for developers.
|
|
|
|
* Clone the repository: `git clone https://github.com/Kris619/Dicekey.git`
|
|
* Install dependencies: `sudo apt-get install python-tk checkinstall`
|
|
* Install Dicekey with GNU make: `make install`
|
|
* Clean up files: `make clean`
|
|
|
|
To uninstall Dicekey: `sudo dpkg -r dicekey`
|
|
|
|
## Development
|
|
|
|
Dicekey is developed on Trisquel GNU/Linux 7 x86_64 with Python 2.7.6
|
|
and checkinstall 1.6.2. There *are* plans to support other platforms.
|
|
|
|
Development follows the the [Semantic
|
|
Versioning](http://semver.org/spec/v2.0.0.html) 2.0.0 specification and the
|
|
[PEP 8](https://www.python.org/dev/peps/pep-0008/) styling guide. Mistakes may
|
|
occur but we shall try to follow these guidelines to the best of our ability.
|
|
|
|
## Copyrights and Licenses
|
|
|
|
Copyright (C) 2016 Kris Lamoureux
|
|
|
|
All Dicekey
|
|
code is [Free Software](https://www.gnu.org/philosophy/free-sw.en.html)
|
|
released under the [GNU General Public
|
|
License](https://github.com/Kris619/Dicekey/blob/master/LICENSE) as published
|
|
by the Free Software Foundation, version 3 of the License.
|
|
|
|
|
|
Copyright (C) 2001 Arnold G. Reinhold, Cambridge, Massachusetts USA.
|
|
|
|
A G Reinhold licenses its rights to the English Diceware Wordlist under the
|
|
[Creative Commons CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/)
|
|
license.
|