diff --git a/README.md b/README.md index 8f51d45..f53283f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@

Readme | - Discord | + Discord | GitHub | Documentation

@@ -118,7 +118,7 @@ # Installation and Testing 🛠️ -> For full setup instructions, see: [**Installation**]() +> For full setup instructions, see: [**Installation**](https://github.com/neon-mmd/websurfx/wiki/installation) To get started with Websurfx, clone the repository, edit the config file which is located in the `websurfx`{.verbatim} directory and install redis server by following the instructions located [here](https://redis.io/docs/getting-started/) and then run the websurfx server and redis server using the following commands: @@ -130,17 +130,6 @@ redis-server -p 8082 & ./target/debug/websurfx ``` -If you want to use the rolling/edge branch, run the following commands instead: - -``` shell -git clone https://github.com/neon-mmd/websurfx.git -cd websurfx -git checkout rolling -cargo build -redis-server -p 8082 & -./target/debug/websurfx -``` - Once you have started the server, open your preferred web browser and navigate to to start using Websurfx. > **Warning** @@ -150,7 +139,7 @@ Once you have started the server, open your preferred web browser and navigate t # Configuration 🔧 -> For full configuration instructions, see: [**Configuration**]() +> For full configuration instructions, see: [**Configuration**](https://github.com/neon-mmd/websurfx/wiki/configuration) Websurfx is configured through the config.lua file, located at `websurfx/config.lua`. @@ -158,7 +147,7 @@ Websurfx is configured through the config.lua file, located at `websurfx/config. # Theming 🎨 -> For full theming and customization instructions, see: [**Theming**]() +> For full theming and customization instructions, see: [**Theming**](https://github.com/neon-mmd/websurfx/wiki/theming) Websurfx comes with several themes and colorschemes by default which you can apply and edit through the config file. Support for custom themes and colorschemes using css and develop your own unique-looking website.