Updating README (#509)

gear-foundation · Nov 11, 2024 · 44d821b · 44d821b
1 parent 64eccc5
commit 44d821b
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 9 deletions.
diff --git a/contracts/battleship/README.md b/contracts/battleship/README.md
@@ -1,7 +1,7 @@
 [![Open in Gitpod](https://img.shields.io/badge/Open_in-Gitpod-white?logo=gitpod)](https://gitpod.io/#FOLDER=battleship/https://github.com/gear-foundation/dapps)
 [![Docs](https://img.shields.io/github/actions/workflow/status/gear-foundation/dapps/contracts.yml?logo=rust&label=docs)](https://dapps.gear.rs/battleship_io)
 
-# [Battleship](https://wiki.gear-tech.io/docs/examples/Gaming/battleship)
+# [Battleship](https://wiki.vara.network/docs/examples/Gaming/Battleship)
 
 ### 🏗️ Building
 
@@ -19,6 +19,5 @@ cargo t -r -p "battleship*" -- --skip gclient
 Run all tests:
 ```sh
 # Download the node binary.
-cargo xtask node
 cargo t -r -p "battleship*"
 ```
diff --git a/contracts/galactic-express/README.md b/contracts/galactic-express/README.md
@@ -1,9 +1,13 @@
-# [Galactic Express](https://wiki.gear-tech.io/docs/examples/Gaming/galactic-express)
+# Galactic Express
 
 Galactic Express (GalEx) is a 100% on-chain PvE economic game.
 
 Deliver the cargo 📦 to the orbit 🌌 using fuel ⛽️ efficiently.
 
+A detailed description of the project can be found on the [wiki](https://wiki.vara.network/docs/examples/Gaming/galactic-express).
+
+⚙️ **Note**: The project code is developed using the [Sails](https://github.com/gear-tech/sails) framework.
+
 ### 🏗️ Building
 
 ```sh

diff --git a/contracts/ping-pong/README.md b/contracts/ping-pong/README.md
@@ -1,9 +1,20 @@
 ## The **ping-pong** program
 
-The program workspace includes the following packages:
-- `ping-pong` is the package allowing to build WASM binary for the program and IDL file for it.  
-  The package also includes integration tests for the program in the `tests` sub-folder
-- `ping-pong-app` is the package containing business logic for the program represented by the `PingPongService` structure.  
-- `ping-pong-client` is the package containing the client for the program allowing to interact with it from another program, tests, or
-  off-chain client.
+A detailed description of the project can be found on the [wiki](https://wiki.vara.network/docs/examples/Ping).
+
+⚙️ **Note**: The project code is developed using the [Sails](https://github.com/gear-tech/sails) framework.
+
+
+### 🏗️ Building
+
+```sh
+cargo b -r -p "ping-pong"
+```
+
+### ✅ Testing
+
+Run all tests, except `gclient` ones:
+```sh
+cargo t -r -p "ping-pong"
+```