Skip to content

Commit cdae664

Browse files
authored
Update README.md
1 parent 88b4f65 commit cdae664

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,25 @@ A Python password manager with a Tkinter GUI and encryption with SQLCipher.
88
- Encryption with SQLCipher
99
- Shortcut button to open website for each account
1010

11-
1211
## Installation
1312
### Binaries
1413

15-
Windows and Linux binaries are provided. Please place in a directory where you have write permissions, the program will create a `data` directory to store each created `*.db` file.
14+
Windows and Linux binaries are provided and is the recommended way to try out the application. Please place in a directory where you have write permissions, the program will create a `data` directory to store each created `*.db` file.
1615

1716
### Source
1817

1918
- Clone the project using `git clone https://github.com/travis-aaron/py_password_manager.git`
20-
- A `pyproject.toml` is included for poetry and a `requirements.txt` for pip. Use `poetry install` or `pip install -r requirements.txt`
19+
- A `pyproject.toml` is included for poetry and a `requirements.txt` for pip. Use `poetry install` or `pip install -r requirements.txt` depending on which you use.
20+
21+
#### Building SQLCipher
22+
23+
**SQLCipher** will need to be compiled.
24+
25+
##### Linux
26+
27+
- View the instructions on the [sqlcipher3](https://github.com/coleifer/sqlcipher3) page under the _[Building a statically linked library](https://github.com/coleifer/sqlcipher3#building-a-statically-linked-library)_ heading.
28+
- A compiled version of SQLCipher for Python 3.11 on Linux is included in the `sqlcipher3` directory, it's recommended to use this only as a last resort.
29+
30+
##### Windows
31+
32+
Compiling SQLCipher on Windows is trickier and not recommended. However, if you must, I recommend the excellent guide by [Dylan L Jones](https://github.com/dylanljones) included in his Pyrekordbox project: [SQLCipher Windows Instructions](https://github.com/dylanljones/pyrekordbox/blob/master/INSTALLATION.md#windows)

0 commit comments

Comments
 (0)