From f8c3c8dcbe826ab418f37a1f1bf4ace17a64ccef Mon Sep 17 00:00:00 2001 From: neon_arch Date: Sun, 30 Apr 2023 20:13:03 +0300 Subject: [PATCH] marking goals/tasks as complete and updating installation instructions --- README.org | 6 +++--- goals.org | 12 ++++-------- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/README.org b/README.org index 45f2d66..a701085 100644 --- a/README.org +++ b/README.org @@ -18,13 +18,13 @@ Websurfx is a lightning-fast, privacy-respecting, secure [[https://en.wikipedia. * Installation and Testing -To get started with Websurfx, clone the repository and run it using the following commands: +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: #+begin_src shell git clone https://github.com/neon-mmd/websurfx.git cd websurfx cargo build - ./target/debug/websurfx --port 8080 + ./target/debug/websurfx #+end_src 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: cd websurfx git checkout rolling cargo build - ./target/debug/websurfx --port 8080 + ./target/debug/websurfx #+end_src Once you have started the server, open your preferred web browser and navigate to http://127.0.0.1:8080 to start using Websurfx. diff --git a/goals.org b/goals.org index b1955c3..038dc25 100644 --- a/goals.org +++ b/goals.org @@ -8,20 +8,16 @@ - [ ] Improve error handling to handle scraping errors, reqwest errors, and other issues. -- [ ] 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. - - [ ] Implement random delays and behaviors to emulate human behavior to evade IP blocking. -- [ ] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator). - - [ ] Create a settings page to allow users to configure the search engine and save their preferences using cookies. - [ ] Add a search engine logo to the index page and the navbar. +- [X] Add Python/Lua configuration options to give more control to the user (server maintainer/administrator). + +- [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. + - [X] Write a rust.yml file for automated testing of the project. - [X] Improve documentation for the project source code.