Update README.md to recent changes (#1247)

* Update README.md to recent changes * Fix typo * Remove backend's docs * Add mdbook generation to makefile * Remove simulating_latency.md * Update summary * Remove mix config
lambdaclass · Dec 15, 2023 · f9f9d98 · f9f9d98
1 parent cd4f0fa
commit f9f9d98
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 373 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,10 @@
-.PHONY: gen-client-protobuf gen-protobuf
+.PHONY: gen-client-protobuf gen-protobuf docs
 
 gen-protobuf: gen-client-protobuf
 
 gen-client-protobuf:
 	protoc --csharp_out=./  communication/messages.proto
-	mv Messages.cs client/Assets/Scripts/Messages.pb.cs
+	mv Messages.cs client/Assets/Scripts/Messages.pb.cs
+
+docs: 
+	cd docs && mdbook serve --open
diff --git a/README.md b/README.md
@@ -10,10 +10,8 @@
   - [Licensing](#licensing)
   - [Requirements](#requirements)
   - [Suggested Development Environment](#suggested-development-environment)
-  - [Project Setup](#project-setup)
-  - [Unity Setup](#unity-setup)
+  - [Project and Unity Setup](#project-and-unity-setup)
   - [Running the Backend](#running-the-backend)
-  - [Useful Commands](#useful-commands)
   - [Documentation](#documentation)
   - [Contact and Socials](#contact-and-socials)
 
@@ -73,20 +71,14 @@ Set up your environment with the following steps:
 
 Your code should now autocomplete.
 
-## Project Setup
-
-Ensure Docker is running and execute the following commands:
+## Project and Unity Setup
+- Open a terminal and clone the project:
 
 ```bash
 git clone https://github.com/lambdaclass/curse_of_myrra
-cd curse_of_myrra/server
-make db
-make setup
 ```
 
-## Unity Setup
-
-- In Unity Hub, click on the add project button and select the `client` folder.
+- In Unity Hub, click on the add project button and select the `curse_of_myrra/client` folder.
 - Choose the correct editor version and download the [Top Down Engine](https://assetstore.unity.com/packages/templates/systems/topdown-engine-89636) by [More Mountains](https://moremountains.com). Include it in the `Assets/ThirdParty` folder after purchasing the license.
 - To test the game, select the scene in `Assets/Scenes/TitleScreen` and run it by clicking the play button.
 
@@ -95,31 +87,13 @@ make setup
 For local testing, use the [game backend](https://github.com/lambdaclass/game_backend). Ensure Docker is running and execute:
 
 ```bash
+git clone https://github.com/lambdaclass/game_backend
+make db
+make setup
 make start
 ```
-
 Remember to set ```localhost``` as the server.
 
-## Useful Commands
-
-```bash
-make tests
-```
-
-Will run Elixir and Rust tests
-
-```bash
-make format
-```
-
-Will format Elixir and Rust code.
-
-```bash
-make prepush
-```
-
-Will format your code and run Credo check and tests.
-
 ## Documentation
 
 Explore our documentation [here](https://docs.curseofmyrra.com/) or run it locally. To run locally, install:
@@ -139,7 +113,6 @@ Open: [http://localhost:3000/](http://localhost:3000/ios_builds.html)
 
 Some key documentation pages:
 
-- [Backend architecture](https://docs.curseofmyrra.com/backend_architecture.html)
 - [Message protocol](https://docs.curseofmyrra.com/message_protocol.html)
 - [Android build](https://docs.curseofmyrra.com/android_builds.html)
 - [IOs builds](https://docs.curseofmyrra.com/ios_builds.html)

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,14 +1,11 @@
 # Summary
 
-- [Backend Architecture](./backend_architecture.md)
 - [Message Protocol](./message_protocol.md)
 - [Game Settings](./game_settings.md)
 - [Data Fileguides](./data_fileguides.md)
 - [Android Build](./android_builds.md)
 - [IOS Build](./ios_builds.md)
-- [WebGL Builds](./webgl_builds.md)
 - [Fluid gameplay in an online environment](./fluid_gameplay.md)
-- [Simulating high latency](./simulating_latency.md)
 - [Common Pitfalls](./common_pitfalls.md)
 - [Unity Animations](./animations.md)
   - [Skill animations](./skill.md)
@@ -18,4 +15,3 @@
 - [Client Player feedbacks](./client_feedbacks.md)
   - [How to add new Feedbacks](./how_to_add_feedbacks.md)
 - [How to add documentation](./add_documentation.md)
-- [Metrics and monitoring](./metrics-and-monitoring.md)
diff --git a/docs/src/backend_architecture.md b/docs/src/backend_architecture.md
diff --git a/docs/src/benchmarking.md b/docs/src/benchmarking.md
diff --git a/docs/src/metrics-and-monitoring.md b/docs/src/metrics-and-monitoring.md