diff --git a/README.md b/README.md index c4918ec..74ccd5f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# QuickSmesh +# QuickSmesh 🏃‍♂️ -**🏃‍♂️A quick and easy way to mine Spacemesh.** +**A quick and easy way to mine Spacemesh.** QuickSmesh has been developed to simplify the process of Smeshing (mining for Spacemesh). Unlike other tools like [Smapp](https://github.com/spacemeshos/smapp) and [go-spacemesh](https://github.com/spacemeshos/go-spacemesh), QuickSmesh aims to provide a user-friendly interface with sensible defaults to make Smeshing a simple process. @@ -23,7 +23,7 @@ Note that QuickSmesh is not a wallet app and cannot store your keys and identiti QuickSmesh is still in its early stages, so there are a few things to keep in mind: - Be very carful of [equivocation](https://docs.spacemesh.io/docs/start/smesher/equivocation)! Make sure you **never** run multiple nodes simultaneously which use the same PoST data, this will result in your PoST data's identity being permanently baned by the network. Soon QuickSmesh will warn you if this might happen. -- QuickSmesh currently does not support generating your own PoST data so at the moment you will need to point QuickSmesh to your pre-existing data. This feature is on our road map. +- QuickSmesh currently does not support generating your own PoST data so at the moment you will need to point QuickSmesh to your pre-existing data. This feature is on our roadmap. - You currently will have to manually copy across your PoST data's `identity.key` file into you Spacemesh node `identities` directory. In the future QuickSmesh will do this automatically. ## Roadmap diff --git a/backend/README.md b/backend/README.md index 22c2212..525dd43 100644 --- a/backend/README.md +++ b/backend/README.md @@ -10,7 +10,7 @@ To run the backend you will need Python 3.10 and have installed the following pa ## Usage -To run the backend and host the front end at the same time run: +To run the backend and host the frontend at the same time run: python3 quicksmesh.py --frontend-dir diff --git a/build-scripts/build-linux.sh b/build-scripts/build-linux.sh index 2257646..acbb5b7 100644 --- a/build-scripts/build-linux.sh +++ b/build-scripts/build-linux.sh @@ -4,9 +4,9 @@ mkdir -p temp -# Set front end build environment variables -QUICKSMESH_VERSION=$1 -SPACEMESH_VERSION=$2 +# Set frontend build environment variables +export QUICKSMESH_VERSION=$1 +export SPACEMESH_VERSION=$2 # Build frontend yarn --cwd ../frontend install diff --git a/build-scripts/build-windows.bat b/build-scripts/build-windows.bat index 9f11299..713047e 100644 --- a/build-scripts/build-windows.bat +++ b/build-scripts/build-windows.bat @@ -4,7 +4,7 @@ REM USAGE: ./build-windows.bat mkdir temp -REM Set front end build environment variables +REM Set frontend build environment variables set "QUICKSMESH_VERSION=%1" set "SPACEMESH_VERSION=%2"