Skip to content

Commit 325255f

Browse files
committed
Updated README to remove mention of RocksDB and LLVM
1 parent df7e380 commit 325255f

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ programming language, it is completely multithreaded; and offers high performanc
107107
- Rust compiler (latest nightly version)
108108
- Cargo (comes with Rust)
109109

110-
### 📥 Installation
110+
## 📥 Installation
111111

112112
[//]: # (#### Option 1: Download pre-compiled binary (Maybe outdated!))
113113

@@ -123,12 +123,9 @@ programming language, it is completely multithreaded; and offers high performanc
123123
Unfortunately, the server is not yet ready for production use. If you want to try it out, you can compile it from source.
124124
</p>
125125

126-
#### Compile from source (Bleeding edge updates, always up-to-date)
126+
### Compile from source (Bleeding edge updates, always up-to-date)
127127

128-
1. Ensure you have LLVM installed on your system. This is required for RocksDB compilation.
129-
- The env variable `LIBCLANG_PATH` must be set to the path of the `[LLVM path]/bin`.
130-
131-
2. Clone and build the project.
128+
##### Clone and build the project.
132129

133130
```bash
134131
# Clone the repository
@@ -139,9 +136,9 @@ cd ferrumc
139136
cargo build --release
140137
```
141138

142-
### The binary will be in target/release/
139+
#### The binary will be in target/release/
143140

144-
### 🖥️ Usage
141+
## 🖥️ Usage
145142

146143
1. Move the FerrumC binary to your desired server directory
147144
2. Open a terminal in that directory
@@ -199,14 +196,14 @@ awesome [Extism](https://extism.org/) project to allow for plugins to be written
199196
JS/TS, Zig and more) while not losing out on the performance gains of native code.
200197

201198
### What does 'FerrumC' mean?
202-
It's a play on words. Ferrum is the Latin word for iron and it ***rust***s. And MC (Minecraft) in the end.
199+
200+
It's a play on words. Ferrum is the Latin word for iron and it ***rust***s. And MC (Minecraft) in the end.
203201
So it becomes Ferru*mc*. Get it? 😄
204202

205203
## 📜 License
206204

207205
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details.
208206

209-
210207
## 🌟 Star History
211208

212209
<a href="https://star-history.com/#ferrumc-rs/ferrumc&Date">

0 commit comments

Comments
 (0)