Merge pull request bepass-org#4 from mohamadkhalaj/main

Added README for building

README.md

@@ -18,6 +18,63 @@ Leveraging `bepass-sdk` and a custom Go implementation of WireGuard, it's design
 2. **Install**: Open the APK file to install.
 3. **Connect**: Launch Oblivion and hit the switch button.
 
+## Building the Project
+
+### Prerequisites
+- Java 17
+- Gradle 8
+- Android Gradle Plugin (AGP) 8.1.2
+- NDK r26b (26.1.10909125)
+- Go 1.20.0
+
+Follow the steps below to build the Oblivion:
+
+### Building Go libraries
+Open the Terminal tab at the bottom of Android Studio.
+
+Navigate to the libs directory:
+
+```bash
+cd app/libs
+```
+Initialize Go modules and install required packages:
+
+```bash
+go mod tidy
+go install golang.org/x/mobile/cmd/gomobile@latest
+go install golang.org/x/mobile/cmd/gobind@latest
+go get golang.org/x/mobile/cmd/gobind
+go get golang.org/x/mobile/cmd/gomobile
+go get golang.org/x/mobile
+```
+Initialize Go mobile:
+
+```bash
+gomobile init
+```
+Bind the Go package to Android:
+
+```bash
+gomobile bind -ldflags '-s -w' -o tun2socks.aar -androidapi 21 -target android .
+```
+### Generate Signed Bundle/APK:
+- In Android Studio, navigate to "Build" in the menu bar.
+- Select "Generate Signed Bundle/APK..."
+- Choose "APK" and proceed.
+
+#### Select Keystore:
+- Click on "Choose existing..." or "Create new..." to locate your keystore file.
+- Enter the keystore password when prompted.
+
+#### Configure APK Signature:
+- Select the appropriate key alias from the dropdown menu.
+- Input the key password.
+- Continue to the next step.
+
+#### Select APK Destination:
+- Choose the destination folder for the signed APK.
+- Finalize by clicking "Finish" to generate the signed APK.
+
 ## Get Involved
 
 We're a community-driven project, aiming to make the internet accessible for all. Whether you want to contribute code, suggest features, or need some help, we'd love to hear from you! Check out our [GitHub Issues](https://github.com/bepass-org/oblivion/issues) or submit a pull request.