Skip to content

Commit 398838c

Browse files
author
Erika Perugachi
authored
Merge pull request #1308 from javiteri95/ReadmeModify
Readme modification to include alice and delete not used script
2 parents aae7bdd + 6993ad4 commit 398838c

File tree

2 files changed

+13
-54
lines changed

2 files changed

+13
-54
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,19 @@ CSC_IDENTITY_AUTO_DISCOVERY=true
6666
DEV_APP_DOMAIN=criptext.com
6767
```
6868

69+
Finally, you must build Alice. Alice is the signal protocol encryption service for desktop apps. You must build and run it to use the criptext electron client. For Linux or Mac Os systems follow the following steps to compile it. If you use Windows please refer to [https://github.com/Criptext/Alice-Windows](https://github.com/Criptext/Alice-Windows) instead.
70+
71+
Steps to compile and run alice on Linux or MacOs:
72+
- enter db_interface
73+
- run bash ${your_os}_setup.sh
74+
- after completed, go to signal_interface folder
75+
- run bash ${your_os}/${your_os}_install_deps.sh
76+
- generate a binding gyp file. The easiest way is to just copy the ${your-os}/${your_os}_binding.gyp file to the root signal_interface folder and rename it as binding.gyp there.
77+
- Ensure that all the dependencies in the binding.gyp file exist in those paths. In case of something is wrong, feel free to modify the file.
78+
- install node-gyp (npm install -g node-gyp or yarn global add node-gyp) with root permissions.
79+
- run node-gyp configure build.
80+
81+
That would install and run Alice in your system.
6982

7083
## Contributing Code
7184

signal_interface/release_alice.sh

Lines changed: 0 additions & 54 deletions
This file was deleted.

0 commit comments

Comments
 (0)