Skip to content

Commit fa083e2

Browse files
authored
Update README.md
1 parent 41a4ad4 commit fa083e2

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,20 +89,36 @@ All [Authenticated Encryption](https://www.cryptopp.com/wiki/Authenticated_Encry
8989

9090

9191
### Compiling & Installing
92-
93-
```shell
92+
### Linux
93+
```bash
94+
git clone https://github.com/baderouaich/Enigma
95+
cd Enigma
96+
# on Linux, run install_sys_deps.sh to install system libraries (X11, wayland..)
97+
bash install_sys_deps.sh
98+
mkdir build && cd build
99+
cmake .. -G"Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
100+
make install -j$(nproc)
101+
```
102+
### Windows
103+
```batch
94104
git clone https://github.com/baderouaich/Enigma
95105
cd Enigma
96-
# on Linux, run linux_sysdeps.sh to install system libraries (X11, wayland..)
97-
# bash linux_sysdeps.sh
98106
mkdir build && cd build
99-
cmake .. -G"Unix Makefiles" -DCMAKE_BUILD_TYPE=Release # or -G"Visual Studio 17 2022" to use the MSVC compiler
100-
make install -j$(nproc) # or -j%NUMBER_OF_PROCESSORS% on Windows
107+
cmake .. -G"Visual Studio 17 2022" -A x64 -DCMAKE_BUILD_TYPE=Release
108+
msbuild Enigma.sln -property:Configuration=Release,MultiProcessorCompilation=true -maxCpuCount -verbosity:minimal -noLogo
101109
```
110+
111+
> [!TIP]
112+
> Export a backup of your encryptions database occasionally from menu **File** -> **Export** and save it somewhere (e.g, clouds like Google Drive).
113+
114+
> [!NOTE]
115+
> Backed-up databases do not store any passwords, all data (text & files) are stored as encrypted ciphers (you can see that using tools like [sqlite3 browser](https://sqlitebrowser.org)), which means, even if your backup is compromised, no one can decrypt your data without the encryption password.
116+
117+
102118
<!--- No `sudo` or `Administrator` privileges are needed for installation.-->
103-
- All Enigma files will be installed to `/home/$(whoami)/Enigma/` (**Linux**) | `C:\Program Files\Enigma\` (**Windows**)
119+
<!--- All Enigma files will be installed to `/home/$(whoami)/Enigma/` (**Linux**) | `C:\Program Files\Enigma\` (**Windows**)
104120
- To uninstall simply remove the installed `Enigma/` directory. Please make sure you export your encryptions from menu `File -> Export`before removing the directory.
105-
121+
-->
106122
<!--
107123
## Compiling
108124
- <i>Clone Repository</i> : `$ git clone https://github.com/baderouaich/Enigma.git`<br>

0 commit comments

Comments
 (0)