neon_arch commited on
Commit
f8c3c8d
1 Parent(s): 71fae8b

marking goals/tasks as complete and updating installation instructions

Browse files
Files changed (2) hide show
  1. README.org +3 -3
  2. goals.org +4 -8
README.org CHANGED
@@ -18,13 +18,13 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia.
18
 
19
  * Installation and Testing
20
 
21
- To get started with Websurfx, clone the repository and run it using the following commands:
22
 
23
  #+begin_src shell
24
  git clone https://github.com/neon-mmd/websurfx.git
25
  cd websurfx
26
  cargo build
27
- ./target/debug/websurfx --port 8080
28
  #+end_src
29
 
30
  If you want to use the rolling/edge branch, run the following commands instead:
@@ -34,7 +34,7 @@ If you want to use the rolling/edge branch, run the following commands instead:
34
  cd websurfx
35
  git checkout rolling
36
  cargo build
37
- ./target/debug/websurfx --port 8080
38
  #+end_src
39
 
40
  Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080 to start using Websurfx.
 
18
 
19
  * Installation and Testing
20
 
21
+ To get started with Websurfx, clone the repository, edit the config file which is located in the =websurfx= directory and run it using the following commands:
22
 
23
  #+begin_src shell
24
  git clone https://github.com/neon-mmd/websurfx.git
25
  cd websurfx
26
  cargo build
27
+ ./target/debug/websurfx
28
  #+end_src
29
 
30
  If you want to use the rolling/edge branch, run the following commands instead:
 
34
  cd websurfx
35
  git checkout rolling
36
  cargo build
37
+ ./target/debug/websurfx
38
  #+end_src
39
 
40
  Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080 to start using Websurfx.
goals.org CHANGED
@@ -8,20 +8,16 @@
8
 
9
  - [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues.
10
 
11
- - [ ] Add the ability for users to change the colorscheme of the page.
12
-
13
- =For example:=
14
-
15
- If a simple theme is used, then there should be the option of 9 different colorschemes to choose from, such as Catppuccino-Mocha, Solarized Dark, Nord, etc.
16
-
17
  - [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking.
18
 
19
- - [ ] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator).
20
-
21
  - [ ] Create a settings page to allow users to configure the search engine and save their preferences using cookies.
22
 
23
  - [ ] Add a search engine logo to the index page and the navbar.
24
 
 
 
 
 
25
  - [X] Write a rust.yml file for automated testing of the project.
26
 
27
  - [X] Improve documentation for the project source code.
 
8
 
9
  - [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues.
10
 
 
 
 
 
 
 
11
  - [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking.
12
 
 
 
13
  - [ ] Create a settings page to allow users to configure the search engine and save their preferences using cookies.
14
 
15
  - [ ] Add a search engine logo to the index page and the navbar.
16
 
17
+ - [X] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator).
18
+
19
+ - [X] Add the ability for users to change the colorscheme of the page. =For example:== If a simple theme is used, then there should be the option of 9 different colorschemes to choose from, such as Catppuccino-Mocha, Solarized Dark, Nord, etc.
20
+
21
  - [X] Write a rust.yml file for automated testing of the project.
22
 
23
  - [X] Improve documentation for the project source code.