diff --git a/README.md b/README.md index 602acf7b2..f91531057 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,16 @@

-This repo includes the source code for the `Spacemesh App`. A desktop application for Windows 10, OS X and Linux which includes a Smesher and a basic wallet. The main artifects of this repo are the app and an app installer for all supported platforms. +This repo includes the source code for the `Spacemesh App`. A desktop application for Windows 10, OS X, and Linux which includes a Smesher and a basic wallet. The main artifacts of this repo are the app and an app installer for all supported platforms. -![](https://github.com/spacemeshos/smapp/blob/develop/resources/smapp_app_smesher.png) +**Important note: Currently, Smapp does not support Hardware Wallets. This feature will be implemented in the future, but until then we highly recommend using [SMCLI](https://github.com/spacemeshos/smcli) to generate the necessary keys for your ledger setup. +Also, the Wallet-only mode is temporarily disabled.** -![](https://github.com/spacemeshos/smapp/blob/develop/resources/smapp_app_wallet.png) +![](smesher +) + +![](wallet +) ## Installation & Quick Start @@ -25,16 +30,16 @@ Download the latest Smapp release from [Spacemesh Website](https://spacemesh.io/ ### Building from Source -Smapp is written in TypeScript and bundled within Electron. You need Node.js (v12) and Yarn to build from source. Make sure they are available on your system. +Smapp is written in TypeScript and bundled within Electron. You need Node.js (v12) and Yarn to build from the source. Make sure they are available on your system. 1. Clone the repository 2. Read `node/use-version` file: this is the version of `go-spacemesh` that should be used 3. Download the specified version from [Go-spacemesh Releases](https://github.com/spacemeshos/go-spacemesh/releases) -4. Put the binary in either `node/windows`, `node/mac`, or `node/linux` folder, depending on you platform +4. Put the binary in either `node/windows`, `node/mac`, or `node/linux` folder, depending on your platform 5. Run `yarn` to install dependencies 6. Run `yarn start` to start the application in development mode -To build and pack application: +To build and pack the application: 1. Run `yarn build` 2. Run one of the commands depending on your platform: @@ -55,10 +60,10 @@ Smapp can be started with additional arguments: Env variable alias: `PPROF_SERVER` - `--test-mode` (boolean) _e.g._ `./Spacemesh --test-mode` - It runs Smapp and the Node under the hood in standalone mode, making it much easier to test and debug application. + It runs Smapp and the Node under the hood in standalone mode, making it much easier to test and debug the application. Env variable alias: `TEST_MODE` -To run application in dev mode with same behavior set env variables instead: +To run the application in dev mode with the same behavior set env variables instead: ``` PPROF_SERVER=1 DISCOVERY_URL=http://localhost:8000/networks.json yarn start ``` @@ -74,12 +79,12 @@ Alias for `--discovery` argument.
Deprecated - > To run the application against DevNet you have to set URL to config file to env variable `DEV_NET_URL`: + > To run the application against DevNet you have to set URL to the config file to env variable `DEV_NET_URL`: > ``` > DEV_NET_URL=https://.../config.json yarn start > ``` > - > To run the application against DevNet in the Wallet Only mode you have to also set URL (or list of URLs separated by commas) to GRPC API provider to env variable `DEV_NET_REMOTE_API`: + > To run the application against DevNet in the Wallet Only mode you have to also set the URL (or list of URLs separated by commas) to GRPC API provider to env variable `DEV_NET_REMOTE_API`: > ``` > export DEV_NET_REMOTE_API=https://192.168.0.1:31030 > export DEV_NET_URL=https://.../config.json @@ -103,7 +108,7 @@ SENTRY_AUTH_TOKEN='special auth token for sentry cli integration' ### Building Artifacts in CI -Smapp uses two workflows. Both of them builds an application for all supported platforms: windows, macOS, linux. +Smapp uses two workflows. Both of them build an application for all supported platforms: Windows, macOS, Linux. - **PR builds** Triggered by open Pull Request and any further changes on the branch. @@ -124,8 +129,9 @@ Smapp uses two workflows. Both of them builds an application for all supported p - [Spacemesh improvement proposals](https://github.com/spacemeshos/SMIPS) -### Run Spacemesh app on Ubuntu -For Ubuntu plarform the Electron has an issue with set up , if u have a smapp version latter 2.0.5 and u want to run it on the Ubuntu > 22.04 platform , please provide ```--no-sandbox``` flag +### Run the Spacemesh app on Ubuntu +We recommend choosing AppImage as it is not possible to embed certain features in the .deb package. +For the Ubuntu platform Electron has an issue with setup, if you want to run it on the Ubuntu > 22.04 platform, please provide ```--no-sandbox``` flag **command:** ```/opt/Spacemesh/spacemesh_app --no-sandbox``` @@ -134,14 +140,14 @@ For Ubuntu plarform the Electron has an issue with set up , if u have a smapp ve ## Troubleshooting -### The first things to check if you encounter any issues with Smapp +### The first thing to check if you encounter any issues with Smapp - Check the Release Notes on GitHub - you might find there the information about the known issues and workarounds to them. - We recommend visiting https://status.spacemesh.io/, to see if Spacemesh Team is already working on this issue. - Check the Smapp version -it should always come from the official source and be the latest released package, update it if needed. - If you have the latest version, restart Smapp and check if the issue remains. - The GPU drivers should be up to date; please check if you have the latest release. For NVIDIA, it should be version 525 (currently). -- Check our [Discord] (https://discord.com/channels/623195163510046732/691261757921951756) chats, the issue might have been discussed there. +- Check our [Discord](https://discord.com/channels/623195163510046732/691261757921951756) chats, the issue might have been discussed there. Additionally: @@ -177,4 +183,4 @@ Additionally: ```/Users/your_username/post``` -- Check if the incoming connections aren’t blocked for go-spacemesh \ No newline at end of file +- Check if the incoming connections aren’t blocked for go-spacemesh