diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f3a4c1 --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,43 @@ | |||
1 | # Sophie | ||
2 | |||
3 | _Messaging app built from the ground up with security in mind_ | ||
4 | |||
5 | This is currently a work in progress, you should probably check back later. | ||
6 | |||
7 | ## Development | ||
8 | |||
9 | This project uses [yarn](https://yarnpkg.com/) to manage its dependencies. | ||
10 | The project structure is based on [Vite Electron Builder Boilerplace](https://github.com/cawa-93/vite-electron-builder) but it was changed to incorporate [react](https://reactjs.org/) and [mobx-state-tree](https://github.com/mobxjs/mobx-state-tree). | ||
11 | |||
12 | To start working, install all dependencies with | ||
13 | |||
14 | ``` sh | ||
15 | yarn install | ||
16 | ``` | ||
17 | |||
18 | To start a development instance of Sophie, which will reload on source changes, run | ||
19 | |||
20 | ``` sh | ||
21 | yarn watch | ||
22 | ``` | ||
23 | |||
24 | To build the application in release mode, run | ||
25 | |||
26 | ``` sh | ||
27 | yarn compile | ||
28 | ``` | ||
29 | |||
30 | ## License | ||
31 | |||
32 | > Copyright (C) 2021-2022 Sophie contributors | ||
33 | > | ||
34 | > This program is free software: you can redistribute it and/or modify | ||
35 | > it under the terms of the GNU Affero General Public License as | ||
36 | > published by the Free Software Foundation, version 3. | ||
37 | > | ||
38 | > This program is distributed in the hope that it will be useful, | ||
39 | > but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
40 | > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
41 | > GNU Affero General Public License for more details. | ||
42 | > You should have received a copy of the GNU Affero General Public License | ||
43 | > along with this program. If not, see <[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)>. | ||