neon_arch
commited on
Commit
β’
34ae87e
1
Parent(s):
1a310ca
chore: revise and improve the readme
Browse files- README.md +20 -62
- images/main_page.png +0 -0
README.md
CHANGED
@@ -5,68 +5,26 @@
|
|
5 |
<b align="center"><a href="README.md">Readme</a></b> |
|
6 |
<b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
|
7 |
<b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
|
8 |
-
<b><a href="
|
9 |
<br /><br />
|
10 |
-
<a href="./LICENSE">
|
11 |
-
<img
|
12 |
-
alt="GitHub"
|
13 |
-
src="https://img.shields.io/github/license/neon-mmd/websurfx?style=flat-square"
|
14 |
-
/>
|
15 |
-
</a>
|
16 |
-
<a href="https://github.com/neon-mmd/websurfx/stargazers">
|
17 |
-
<img
|
18 |
-
alt="GitHub Repo stars"
|
19 |
-
src="https://img.shields.io/github/stars/neon-mmd/websurfx?style=flat-square"
|
20 |
-
/>
|
21 |
-
</a>
|
22 |
-
<a href="https://github.com/neon-mmd/websurfx/forks">
|
23 |
-
<img
|
24 |
-
alt="GitHub forks"
|
25 |
-
src="https://img.shields.io/github/forks/neon-mmd/websurfx?style=flat-square"
|
26 |
-
/>
|
27 |
-
</a>
|
28 |
<a href="#">
|
29 |
<img
|
30 |
alt="GitHub code size in bytes"
|
31 |
src="https://img.shields.io/github/languages/code-size/neon-mmd/websurfx?style=flat-square"
|
32 |
/>
|
33 |
</a>
|
34 |
-
<a href="https://github.com/neon-mmd/websurfx/issues">
|
35 |
-
<img
|
36 |
-
alt="GitHub issues"
|
37 |
-
src="https://img.shields.io/github/issues/neon-mmd/websurfx?style=flat-square"
|
38 |
-
/>
|
39 |
-
</a>
|
40 |
-
<a href="https://github.com/neon-mmd/websurfx/pulls">
|
41 |
-
<img
|
42 |
-
alt="GitHub pull requests"
|
43 |
-
src="https://img.shields.io/github/issues-pr/neon-mmd/websurfx?style=flat-square"
|
44 |
-
/>
|
45 |
-
</a>
|
46 |
<a href="https://github.com/neon-mmd/websurfx/actions">
|
47 |
<img
|
48 |
alt="GitHub Workflow Status"
|
49 |
src="https://img.shields.io/github/actions/workflow/status/neon-mmd/websurfx/rust.yml?style=flat-square"
|
50 |
/>
|
51 |
</a>
|
52 |
-
<a href="">
|
53 |
-
<img
|
54 |
-
alt="GitHub release (latest by date including pre-releases)"
|
55 |
-
src="https://img.shields.io/github/v/release/neon-mmd/websurfx?include_prereleases"
|
56 |
-
/>
|
57 |
-
</a>
|
58 |
<a href=""
|
59 |
><img
|
60 |
alt="Maintenance"
|
61 |
src="https://img.shields.io/maintenance/yes/2023?style=flat-square"
|
62 |
/>
|
63 |
</a>
|
64 |
-
<a href="">
|
65 |
-
<img
|
66 |
-
alt="GitHub contributors"
|
67 |
-
src="https://img.shields.io/github/contributors-anon/neon-mmd/websurfx?style=flat-square"
|
68 |
-
/>
|
69 |
-
</a>
|
70 |
<a href="https://gitpod.io/#https://github.com/neon-mmd/websurfx">
|
71 |
<img
|
72 |
alt="Gitpod"
|
@@ -126,7 +84,7 @@
|
|
126 |
|
127 |
<img align="center" src="./images/404_error_page.png" />
|
128 |
|
129 |
-
**[β¬οΈ Back to Top](
|
130 |
|
131 |
# Features π
|
132 |
|
@@ -136,11 +94,11 @@
|
|
136 |
- π¨ Ad-free and clean results
|
137 |
- π and lots more...
|
138 |
|
139 |
-
**[β¬οΈ Back to Top](
|
140 |
|
141 |
# Installation and Testing π οΈ
|
142 |
|
143 |
-
> For full setup instructions, see: [**Installation**](
|
144 |
|
145 |
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:
|
146 |
|
@@ -157,36 +115,36 @@ Once you have started the server, open your preferred web browser and navigate t
|
|
157 |
> **Warning**
|
158 |
> Please be aware that the project is still in the testing phase and is not ready for production use.
|
159 |
|
160 |
-
**[β¬οΈ Back to Top](
|
161 |
|
162 |
# Configuration π§
|
163 |
|
164 |
-
> For full configuration instructions, see: [**Configuration**](
|
165 |
|
166 |
Websurfx is configured through the config.lua file, located at `websurfx/config.lua`.
|
167 |
|
168 |
-
**[β¬οΈ Back to Top](
|
169 |
|
170 |
# Theming π¨
|
171 |
|
172 |
-
> For full theming and customization instructions, see: [**Theming**](
|
173 |
|
174 |
Websurfx comes with several themes and color schemes by default, which you can apply and edit through the config file. Supports custom themes and color schemes using CSS, allowing you to develop your own unique-looking website.
|
175 |
|
176 |
-
**[β¬οΈ Back to Top](
|
177 |
|
178 |
# Multi-Language Support π
|
179 |
|
180 |
> **Note**
|
181 |
> Currently, we do not support other languages, but in the future, we will start accepting contributions regarding language support because we believe that language should not be a barrier to entry.
|
182 |
|
183 |
-
**[β¬οΈ Back to Top](
|
184 |
|
185 |
# System Requirements π
|
186 |
|
187 |
At present, we only support x86_64 architecture systems, but we would love to have contributions that extend to other architectures as well.
|
188 |
|
189 |
-
**[β¬οΈ Back to Top](
|
190 |
|
191 |
# FAQ (Frequently Asked Questions) π¨οΈ
|
192 |
|
@@ -202,13 +160,13 @@ Websurfx is distributed under the **AGPLv3** license to keep the source code ope
|
|
202 |
|
203 |
Rust was chosen as the programming language for Websurfx because of its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which contributes to Websurfx's speed and responsiveness. Furthermore, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.
|
204 |
|
205 |
-
**[β¬οΈ Back to Top](
|
206 |
|
207 |
# More Contributers Wanted π£
|
208 |
|
209 |
We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [project board](https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen) and the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines and rules for making contributions.
|
210 |
|
211 |
-
**[β¬οΈ Back to Top](
|
212 |
|
213 |
# Supporting Websurfx π
|
214 |
|
@@ -224,20 +182,20 @@ Several areas that we need a bit of help with at the moment are:
|
|
224 |
- Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or something else.
|
225 |
- Star Websurfx on GitHub.
|
226 |
|
227 |
-
**[β¬οΈ Back to Top](
|
228 |
|
229 |
# Documentation π
|
230 |
|
231 |
> **Note**
|
232 |
-
> We welcome any contributions to the [documentation](
|
233 |
|
234 |
-
**[β¬οΈ Back to Top](
|
235 |
|
236 |
# Roadmap π£οΈ
|
237 |
|
238 |
> Coming soon!! π.
|
239 |
|
240 |
-
**[β¬οΈ Back to Top](
|
241 |
|
242 |
# Contributing π
|
243 |
|
@@ -251,13 +209,13 @@ Check out this [video](https://youtu.be/FccdqCucVSI) by Mr. Nick on how to contr
|
|
251 |
|
252 |
If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) document for more information.
|
253 |
|
254 |
-
**[β¬οΈ Back to Top](
|
255 |
|
256 |
# License π
|
257 |
|
258 |
Websurfx is licensed under the [AGPLv3](LICENSE) license.
|
259 |
|
260 |
-
**[β¬οΈ Back to Top](
|
261 |
|
262 |
# Credits π€
|
263 |
|
@@ -271,7 +229,7 @@ We would like to thank the following people for their contributions and support:
|
|
271 |
<br />
|
272 |
</p>
|
273 |
|
274 |
-
**[β¬οΈ Back to Top](
|
275 |
|
276 |
---
|
277 |
|
|
|
5 |
<b align="center"><a href="README.md">Readme</a></b> |
|
6 |
<b><a href="https://discord.gg/SWnda7Mw5u">Discord</a></b> |
|
7 |
<b><a href="https://github.com/neon-mmd/websurfx">GitHub</a></b> |
|
8 |
+
<b><a href="./docs/README.md">Documentation</a></b>
|
9 |
<br /><br />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
10 |
<a href="#">
|
11 |
<img
|
12 |
alt="GitHub code size in bytes"
|
13 |
src="https://img.shields.io/github/languages/code-size/neon-mmd/websurfx?style=flat-square"
|
14 |
/>
|
15 |
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
16 |
<a href="https://github.com/neon-mmd/websurfx/actions">
|
17 |
<img
|
18 |
alt="GitHub Workflow Status"
|
19 |
src="https://img.shields.io/github/actions/workflow/status/neon-mmd/websurfx/rust.yml?style=flat-square"
|
20 |
/>
|
21 |
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
22 |
<a href=""
|
23 |
><img
|
24 |
alt="Maintenance"
|
25 |
src="https://img.shields.io/maintenance/yes/2023?style=flat-square"
|
26 |
/>
|
27 |
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
28 |
<a href="https://gitpod.io/#https://github.com/neon-mmd/websurfx">
|
29 |
<img
|
30 |
alt="Gitpod"
|
|
|
84 |
|
85 |
<img align="center" src="./images/404_error_page.png" />
|
86 |
|
87 |
+
**[β¬οΈ Back to Top](#--)**
|
88 |
|
89 |
# Features π
|
90 |
|
|
|
94 |
- π¨ Ad-free and clean results
|
95 |
- π and lots more...
|
96 |
|
97 |
+
**[β¬οΈ Back to Top](#--)**
|
98 |
|
99 |
# Installation and Testing π οΈ
|
100 |
|
101 |
+
> For full setup instructions, see: [**Installation**](./docs/installation.md)
|
102 |
|
103 |
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:
|
104 |
|
|
|
115 |
> **Warning**
|
116 |
> Please be aware that the project is still in the testing phase and is not ready for production use.
|
117 |
|
118 |
+
**[β¬οΈ Back to Top](#--)**
|
119 |
|
120 |
# Configuration π§
|
121 |
|
122 |
+
> For full configuration instructions, see: [**Configuration**](./docs/configuration.md)
|
123 |
|
124 |
Websurfx is configured through the config.lua file, located at `websurfx/config.lua`.
|
125 |
|
126 |
+
**[β¬οΈ Back to Top](#--)**
|
127 |
|
128 |
# Theming π¨
|
129 |
|
130 |
+
> For full theming and customization instructions, see: [**Theming**](./docs/theming.md)
|
131 |
|
132 |
Websurfx comes with several themes and color schemes by default, which you can apply and edit through the config file. Supports custom themes and color schemes using CSS, allowing you to develop your own unique-looking website.
|
133 |
|
134 |
+
**[β¬οΈ Back to Top](#--)**
|
135 |
|
136 |
# Multi-Language Support π
|
137 |
|
138 |
> **Note**
|
139 |
> Currently, we do not support other languages, but in the future, we will start accepting contributions regarding language support because we believe that language should not be a barrier to entry.
|
140 |
|
141 |
+
**[β¬οΈ Back to Top](#--)**
|
142 |
|
143 |
# System Requirements π
|
144 |
|
145 |
At present, we only support x86_64 architecture systems, but we would love to have contributions that extend to other architectures as well.
|
146 |
|
147 |
+
**[β¬οΈ Back to Top](#--)**
|
148 |
|
149 |
# FAQ (Frequently Asked Questions) π¨οΈ
|
150 |
|
|
|
160 |
|
161 |
Rust was chosen as the programming language for Websurfx because of its memory safety features, which can help prevent vulnerabilities and make the codebase more secure. Rust is also faster than C++, which contributes to Websurfx's speed and responsiveness. Furthermore, the Rust ownership and borrowing system enables secure concurrency and thread safety in the program.
|
162 |
|
163 |
+
**[β¬οΈ Back to Top](#--)**
|
164 |
|
165 |
# More Contributers Wanted π£
|
166 |
|
167 |
We are looking for more willing contributors to help grow this project. For more information on how you can contribute, check out the [project board](https://github.com/neon-mmd/websurfx/projects?query=is%3Aopen) and the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines and rules for making contributions.
|
168 |
|
169 |
+
**[β¬οΈ Back to Top](#--)**
|
170 |
|
171 |
# Supporting Websurfx π
|
172 |
|
|
|
182 |
- Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget, or something else.
|
183 |
- Star Websurfx on GitHub.
|
184 |
|
185 |
+
**[β¬οΈ Back to Top](#--)**
|
186 |
|
187 |
# Documentation π
|
188 |
|
189 |
> **Note**
|
190 |
+
> We welcome any contributions to the [documentation](./docs/) as this will benefit everyone who uses this project.
|
191 |
|
192 |
+
**[β¬οΈ Back to Top](#--)**
|
193 |
|
194 |
# Roadmap π£οΈ
|
195 |
|
196 |
> Coming soon!! π.
|
197 |
|
198 |
+
**[β¬οΈ Back to Top](#--)**
|
199 |
|
200 |
# Contributing π
|
201 |
|
|
|
209 |
|
210 |
If you are a developer, have a look at the [CONTRIBUTING.org](CONTRIBUTING.md) document for more information.
|
211 |
|
212 |
+
**[β¬οΈ Back to Top](#--)**
|
213 |
|
214 |
# License π
|
215 |
|
216 |
Websurfx is licensed under the [AGPLv3](LICENSE) license.
|
217 |
|
218 |
+
**[β¬οΈ Back to Top](#--)**
|
219 |
|
220 |
# Credits π€
|
221 |
|
|
|
229 |
<br />
|
230 |
</p>
|
231 |
|
232 |
+
**[β¬οΈ Back to Top](#--)**
|
233 |
|
234 |
---
|
235 |
|
images/main_page.png
CHANGED
![]() |
![]() |