From cc40f8ce6c824f6784074af16a1e16f380684099 Mon Sep 17 00:00:00 2001 From: Vijay A Date: Sun, 2 Jan 2022 21:04:44 +0530 Subject: Add documentation about specific pre-requisites for new contributors Signed-off-by: Vijay A --- README.md | 16 +++++++++++++--- 1 file 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 @@ +- [Sophie](#sophie) + - [Development](#development) + - [License](#license) + # Sophie _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. ## 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). +The 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. +The 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). + +After installing `node`, you can install `yarn` with + +``` sh +npm i -g yarn +yarn set version 3.1.1 +``` To start working, install all dependencies with @@ -60,4 +71,3 @@ yarn typecheck > 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