Update README.md file (#28)

* Add README.md file * Add README.md file * Add README.md file * Add installation steps * Add setup instructions * Remove emulator from setup instruction * Add links for installation * Change link for JDK * Move device setup instructions below yarn * Setup for example-signer * Update with steps for installing .deb file --------- Co-authored-by: IshaVenikar <ishavenikar7@gmail.com> Co-authored-by: Adw8 <adwait@deepstacksoft.com> Co-authored-by: Nabarun Gogoi <nabarun@deepstacksoft.com>
2024-03-01 15:14:34 +05:30 · 2024-03-01 15:14:34 +05:30 · 85e5a5e9bc
commit 85e5a5e9bc
parent 7db0edce75
1 changed files with 122 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,123 @@
 # laconic-wallet
+
+### Install
+
+- Install [Node](https://nodejs.org/en/download/package-manager/)
+
+- Install [version 17](https://download.oracle.com/java/17/latest/jdk-17_linux-x64_bin.deb) of the Java SE Development Kit (JDK) (Clicking on the link will download the .deb file)
+
+  - Install using the `.deb` file
+    ```bash
+    sudo dpkg -i jdk-17_linux-x64_bin.deb
+    ```
+
+  - Check Oracle JDK docs for installation in other platforms: https://docs.oracle.com/en/java/javase/17/install/overview-jdk-installation.html
+
+- Install [Android Studio](https://developer.android.com/studio/index.html)
+
+- In the installation wizard check the following items:
+
+  - Android SDK
+
+  - Android SDK Platform
+
+  - Android Virtual Device
+
+- Install Android SDK
+
+  - Open Android Studio -> Configure -> SDK Manager -> SDK PLatfrom Tab.
+
+  - Check the box next to "Show Package Details" in the bottom right corner. Look for and expand the Android 13 (Tiramisu) entry, then make sure the following items are checked:
+
+    - Android SDK Platform 33
+
+    - Intel x86 Atom_64 System Image or Google APIs Intel x86 Atom System Image
+
+  - Select SDK Tools and check the box next to "Show Package Details"
+
+  - Select Android SDK Build-Tools 33.0.0
+
+  - Click Apply
+
+- Configure the `ANDROID_HOME` environment variable
+
+- Add the following lines to your `$HOME/.bash_profile` or `$HOME/.bashrc` (if you are using zsh then `~/.zprofile` or `~/.zshrc`) config file:
+
+  ```bash
+  export ANDROID_HOME=$HOME/Android/Sdk
+  export PATH=$PATH:$ANDROID_HOME/emulator
+  export PATH=$PATH:$ANDROID_HOME/platform-tools
+  ```
+
+- Type `source $HOME/.bash_profile` for bash or `source $HOME/.zprofile` to load the config into your current shell. Verify that `ANDROID_HOME` has been set by running
+
+  ```bash
+  echo $ANDROID_HOME
+  ```
+
+- and that the appropriate directories have been added to your path by running
+
+  ```bash
+  echo $PATH
+  ```
+
+## Setup for laconic-wallet
+
+1. Clone this repository:
+
+   ```
+   git clone git@github.com:deep-stack/laconic-wallet.git
+   ```
+
+2. Enter the project directory:
+
+   ```
+   cd laconic-wallet
+   ```
+
+3. Install the dependencies:
+
+   ```
+   yarn
+   ```
+
+4. Set up the Android device:
+
+   - For a physical device, refer to the [React Native documentation for running on a physical device]("https://reactnative.dev/docs/running-on-device)
+
+   - For a virtual device, continue with the steps.
+
+5. Start the application
+
+   ```
+   yarn start
+   ```
+
+6. Press `a` to run the application on android
+
+## Setup for example-signer-app
+
+1. Clone the repository:
+
+   ```
+   git clone git@github.com:deep-stack/example-signer-app.git
+   ```
+
+2. Enter the project directory:
+
+   ```
+   cd example-signer-app
+   ```
+
+3. Install the dependancies
+    ```
+    yarn
+    ```
+4. Start the application
+
+   ```
+   yarn start
+   ```
+5. Press `a` to run the application on android
+
+You should see both the apps running on your emulator or physical device.