Skip to content

Commit 74c1993

Browse files
committed
Added a Screen shot, and more instructions
1 parent 1accb19 commit 74c1993

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,24 @@ allowing for the delivery of any static content on your local desktop environmen
99

1010
## What is for ?
1111

12-
Originally, I designed this software to bundle [mdWiki](http://dynalon.github.io/mdwiki/#!index.md) static web pages. But given the nature of a Webserver, it can be used to a wide variaty of cases, for example adding that to a USB drive or a shared folder.
12+
![PythonUSBWebServer](docs/screenshots/PythonUSBWebServer_2020-12-05_19-06-10.png)
13+
14+
Originally, I designed this software to bundle [MdWiki](http://dynalon.github.io/mdwiki/#!index.md) static web pages into a singles package. But given the nature of a Webserver, it can be used to a wide variaty of cases, for example in a USB drive or a shared folder.
1315

1416
_Note: using this software as a web server exposed to the public internet _it's not recommended_, since that would require probably a whole new tier of security measures._
1517

1618

1719
## How To Use
1820

1921
1. Just drop both the _.exe_ and _config.yaml_ into any windows folder (You can grab the lastest version [here](https://github.com/thethales/PythonUSBWebServer/releases))
20-
2. That's it
22+
2. That's it. The server will serve the files following the configurations of the [config.yaml](config.yaml) file.
23+
2124

2225

2326
# Development
2427

2528

26-
For developing new features for this repo or your own you can follow the instructions listed below. Any pull request or issues are more than welcome.
29+
For developing new features for this repo or your own, you can follow the instructions listed below. (Any pull request or issues are more than welcome).
2730

2831
1. Check the [prerequistes list](README.md#Development##Prerequisites) and confirm that everything is in order
2932
2. Clone the repository
@@ -44,6 +47,7 @@ For developing new features for this repo or your own you can follow the instruc
4447
## Prerequisites
4548

4649
- This project is based on the Python Programming Language and requires Python 3.8 or above. You can obtain a free copy of Python [here](https://www.python.org/downloads/)
50+
- To generate the Windows binaries you will need the [Auto-Py-To-Exe](https://pypi.org/project/auto-py-to-exe/), see the Python Dependencies for instructions.
4751

4852

4953
# Configuring and Setup
18.8 KB
Loading

0 commit comments

Comments
 (0)