aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Vijay A <vraravam@users.noreply.github.com>2022-01-02 21:04:44 +0530
committerLibravatar Vijay A <vraravam@users.noreply.github.com>2022-01-02 21:04:45 +0530
commitcc40f8ce6c824f6784074af16a1e16f380684099 (patch)
treed0cae065af452b67f9a18677e49e61e7a593f645
parentchore: Add @avijayr as a copyright holder (diff)
downloadsophie-cc40f8ce6c824f6784074af16a1e16f380684099.tar.gz
sophie-cc40f8ce6c824f6784074af16a1e16f380684099.tar.zst
sophie-cc40f8ce6c824f6784074af16a1e16f380684099.zip
Add documentation about specific pre-requisites for new contributors
Signed-off-by: Vijay A <vraravam@users.noreply.github.com>
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index 15e179a..3ba0b92 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,15 @@ 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
20yarn set version 3.1.1
21```
11 22
12To start working, install all dependencies with 23To start working, install all dependencies with
13 24
@@ -60,4 +71,3 @@ yarn typecheck
60> GNU Affero General Public License for more details. 71> GNU Affero General Public License for more details.
61> You should have received a copy of the GNU Affero General Public License 72> 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;. 73> along with this program. If not, see &lt;[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/)&gt;.
63