alamin/websurfx
alamin/websurfx
0
0
Fork 0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-11-21 21:48:21 -05:00
Code Issues Releases Activity

chore: add installation intructions on how to install cargo

Browse Source
This commit is contained in:
neon_arch 2023-05-26 13:34:14 +03:00
parent 34ae87e4a4
commit 995b9ae42f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -100,12 +100,14 @@
> For full setup instructions, see: [**Installation**](./docs/installation.md)
To get started with Websurfx, clone the repository, edit the config file, which is located in the `websurfx`{.verbatim} directory, and install the 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:
Before you can start building `websurfx`, you will need to have `Cargo` installed on your system. You can find the installation instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
To get started with Websurfx, clone the repository, edit the config file, which is located in the `websurfx/` directory, and install the 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:
``` shell
git clone https://github.com/neon-mmd/websurfx.git
cd websurfx
cargo build
cargo build -r
redis-server --port 8082 &
./target/debug/websurfx
```