neon_arch
commited on
Commit
•
995b9ae
1
Parent(s):
34ae87e
chore: add installation intructions on how to install cargo
Browse files
README.md
CHANGED
@@ -100,12 +100,14 @@
|
|
100 |
|
101 |
> For full setup instructions, see: [**Installation**](./docs/installation.md)
|
102 |
|
103 |
-
|
|
|
|
|
104 |
|
105 |
``` shell
|
106 |
git clone https://github.com/neon-mmd/websurfx.git
|
107 |
cd websurfx
|
108 |
-
cargo build
|
109 |
redis-server --port 8082 &
|
110 |
./target/debug/websurfx
|
111 |
```
|
|
|
100 |
|
101 |
> For full setup instructions, see: [**Installation**](./docs/installation.md)
|
102 |
|
103 |
+
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).
|
104 |
+
|
105 |
+
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:
|
106 |
|
107 |
``` shell
|
108 |
git clone https://github.com/neon-mmd/websurfx.git
|
109 |
cd websurfx
|
110 |
+
cargo build -r
|
111 |
redis-server --port 8082 &
|
112 |
./target/debug/websurfx
|
113 |
```
|