From 265bac239ad808db53ebab8d5fd7903080c92c94 Mon Sep 17 00:00:00 2001 From: Kristóf Marussy Date: Thu, 23 Dec 2021 17:36:03 +0100 Subject: docs: Add README --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f3a4c1 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Sophie + +_Messaging app built from the ground up with security in mind_ + +This is currently a work in progress, you should probably check back later. + +## Development + +This project uses [yarn](https://yarnpkg.com/) to manage its dependencies. +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). + +To start working, install all dependencies with + +``` sh +yarn install +``` + +To start a development instance of Sophie, which will reload on source changes, run + +``` sh +yarn watch +``` + +To build the application in release mode, run + +``` sh +yarn compile +``` + +## License + +> Copyright (C) 2021-2022 Sophie contributors +> +> This program is free software: you can redistribute it and/or modify +> it under the terms of the GNU Affero General Public License as +> published by the Free Software Foundation, version 3. +> +> This program is distributed in the hope that it will be useful, +> but WITHOUT ANY WARRANTY; without even the implied warranty of +> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +> GNU Affero General Public License for more details. +> You should have received a copy of the GNU Affero General Public License +> along with this program. If not, see <[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)>. -- cgit v1.2.3-54-g00ecf