summaryrefslogtreecommitdiff
path: root/README.txt
blob: 9d62fe0e6e2b9b5997ac227dd46a45cc55f66415 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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