aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Vijay A <avijayr@protonmail.com>2022-01-02 15:47:33 +0000
committerLibravatar Vijay A <avijayr@protonmail.com>2022-01-02 15:47:33 +0000
commitdb8c76c24a7c7a84e5b774984a31bd8b55a19f88 (patch)
tree3fc63fe6c7661acd2419a485ebff55ba1873926b
parentchore: Add @avijayr as a copyright holder (diff)
parentRemove cmd about 'yarn set version' (diff)
downloadsophie-db8c76c24a7c7a84e5b774984a31bd8b55a19f88.tar.gz
sophie-db8c76c24a7c7a84e5b774984a31bd8b55a19f88.tar.zst
sophie-db8c76c24a7c7a84e5b774984a31bd8b55a19f88.zip
Merge branch 'developer-documentation' into 'main'
Add documentation about specific pre-requisites for new contributors Closes #11 See merge request say-hi-to-sophie/sophie!4
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 15e179a..ccd3cae 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,7 @@
1- [Sophie](#sophie)
2 - [Development](#development)
3 - [License](#license)
4
1# Sophie 5# Sophie
2 6
3_Messaging app built from the ground up with security in mind_ 7_Messaging app built from the ground up with security in mind_
@@ -6,8 +10,14 @@ This is currently a work in progress, you should probably check back later.
6 10
7## Development 11## Development
8 12
9This project uses [yarn](https://yarnpkg.com/) to manage its dependencies. 13The codebase is built using [nodejs](https://nodejs.org/) `>=16.13.x`, and uses [yarn](https://yarnpkg.com/) (version `3.1.1`) to manage its dependencies.
10The 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). 14The project structure is based on [Vite Electron Builder Boilerplate](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).
15
16After installing `node`, you can install `yarn` with
17
18``` sh
19npm i -g yarn
20```
11 21
12To start working, install all dependencies with 22To start working, install all dependencies with
13 23
@@ -60,4 +70,3 @@ yarn typecheck
60> GNU Affero General Public License for more details. 70> GNU Affero General Public License for more details.
61> You should have received a copy of the GNU Affero General Public License 71> You should have received a copy of the GNU Affero General Public License
62> along with this program. If not, see &lt;[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)&gt;. 72> along with this program. If not, see &lt;[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)&gt;.
63