Skip to content

Commit 2ed5ea1

Browse files
authored
Update installation instructions (#37)
1 parent 3459c75 commit 2ed5ea1

File tree

1 file changed

+30
-12
lines changed

1 file changed

+30
-12
lines changed

README.md

+30-12
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
Very simple Python3-based GUI application to generate secure and random password.
3838

3939
## Download Latest Version
40+
If you want to generate passwords from terminal, download and install the CLI Backend. To use the graphical interface download both the backend and frontend. For installation, check [here](#)
4041
<p align="center">
4142
<a href="https://github.com/hsbasu/simple-pwgen/zipball/master">Download Source (.zip)</a></br>
4243
<a href="https://github.com/hsbasu/simple-pwgen/tarball/master">Download Source (.tar.gz)</a></br>
@@ -66,10 +67,12 @@ The main purpose of this application is to generate random and strong passwords.
6667
- [Dependencies](#dependencies)
6768
- [Debian/Ubuntu based systems](#debianubuntu-based-distro)
6869
- [Other Linux-based systems](#other-linux-based-distro)
69-
- [Installation](#build-and-install-the-latest-version)
70-
- [Debian/Ubuntu based systems](#debianubuntu-based-systems)
71-
- [Other Linux-based systems](#other-linux-based-systems)
72-
- [For Developers](#for-developers)
70+
- [Installation](#installation)
71+
- [1. Download and install binary files](#1-download-and-install-binary-files)
72+
- [2. Build and Install from source](#2-build-and-install-from-source)
73+
- [Debian/Ubuntu based systems](#debianubuntu-based-systems)
74+
- [Other Linux-based systems](#other-linux-based-systems)
75+
- [For Developers](#for-developers)
7376
- [User Manual](#user-manual)
7477
- [Issue Tracking and Contributing](#issue-tracking-and-contributing)
7578
- [Contributors](#contributors)
@@ -85,6 +88,8 @@ python3-tldextract
8588
```
8689
To use or test Simple Password Generator, you need these dependencies to be installed.
8790

91+
**Note**: If you are using `gdebi` to install **Simple Password Generator** from a `.deb` file, it will automatically install the dependencies and you can skip this step.
92+
8893
### Debian/Ubuntu based distro
8994
To install dependencies on Debian/Ubuntu based systems, run:
9095
```
@@ -98,8 +103,20 @@ Remove `apt install` in the command given in [Debian/Ubuntu based distros](#debi
98103

99104
**Note**: There might be cases where one or more dependencies might not be available for your system. But that is highly unlikely. In such situations, please [create an issue](#issue-tracking-and-contributing).
100105

101-
## Build and Install the Latest Version
102-
### Debian/Ubuntu based systems
106+
## Installation
107+
There are two ways, this app can be installed on a Debian/Ubuntu based system.
108+
109+
### 1. Download and install binary files
110+
Download the latest binary .deb files from [here](https://github.com/hsbasu/simple-pwgen/releases/latest).
111+
First install the CLI Backend. Then install the GUI Frontend as
112+
```
113+
sudo dpkg -i python3-simple-pwgen*.deb
114+
sudo dpkg -i simple-pwgen*.deb
115+
```
116+
117+
### 2. Build and Install From Source
118+
If you are having trouble installing the pre-built binary , build them from source.
119+
#### Debian/Ubuntu based systems
103120
There are two methods, this app can be installed/used on a Debian/Ubuntu based system. First, download and unzip the source package using:
104121
```
105122
wget https://github.com/hsbasu/simple-pwgen/archive/refs/heads/master.zip
@@ -114,30 +131,31 @@ cd simple-pwgen-master
114131
```
115132
from the `simple-pwgen-master` in a terminal. It will create the translations/locales in `usr/share/locale`.
116133

117-
2. Copy the contents of `usr/` to `/usr/`:
134+
2. Install python package using `pip3`:
118135
```
119-
sudo cp -R usr /
136+
sudo pip3 install .
120137
```
138+
It will install all files under `/usr/local/`
121139
3. Compile `schemas` using:
122140
```
123-
sudo glib-compile-schemas /usr/share/glib-2.0/schemas
141+
sudo glib-compile-schemas /usr/local/share/glib-2.0/schemas
124142
```
125143

126144
2. **Option 2:** Build a debian package and install it. To build a debian package on your own:
127145
1. from the `simple-pwgen-master` run:
128146
```
129147
dpkg-buildpackage --no-sign
130148
```
131-
This will create a `simple-pwgen_*.deb` package at `../simple-pwgen-master`.
149+
This will create a `simple-pwgen_*.deb` and `python3-simple-pwgen_*.deb` package at `../simple-pwgen-master`.
132150

133151
2. Install the debian package using
134152
```
135-
sudo dpkg -i ../simple-pwgen_*.deb
153+
sudo dpkg -i ../*simple-pwgen_*.deb
136154
sudo apt install -f
137155
```
138156
After it is installed, run `simple-pwgen` from terminal or use the `simple-pwgen.desktop`.
139157

140-
### Other Linux-based systems
158+
#### Other Linux-based systems
141159
1. Install the [dependencies](#other-linux-based-distro).
142160
2. From instructions for [Debian/Ubuntu based systems](#debianubuntu-based-systems), follow **Option 1**.
143161

0 commit comments

Comments
 (0)