Initial commit

1 files changed, 48 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..9d62fe0
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,48 @@
+REQUIREMENTS
+------------
+You need the Rust toolchain installed (rustup).
+<https://rustup.rs>
+
+
+COMPILATION
+-----------
+1. Open your terminal in the project folder.
+2. Build the project in release mode:
+   cargo build --release
+
+The executable will be generated at: target/release/lan-file-server
+For easier access, you can move the executable somewhere else:
+
+cp target/release/lan-file-server ~/your/desired/dir
+
+
+USAGE
+-----
+Run the server by providing the directory you want to share:
+
+./lan-file-server --dir ~/dir/to/your/files
+
+Optional flags:
+--mode: Choose "simple" (read-only file browser) or "upload" (allows uploads).
+--port: Specify a custom port number.
+
+Once running, the program will print the local and network URLs you can open in your web browser.
+
+
+LICENSE
+-------
+This project is licensed under either of:
+
+- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
+
+at your option.
+
+
+THIRD-PARTY LICENSES
+--------------------
+
+This project uses third-party dependencies.
+Their licenses are listed in:
+
+THIRD-PARTY-LICENSES.html