Skip to content

Commit

Permalink
feat: Update read me with detailed usage scenario
Browse files Browse the repository at this point in the history
  • Loading branch information
selengalp committed Feb 6, 2023
1 parent 85eb5b7 commit 8959f2e
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Repo for switching AP mode and client mode of wifi
# Repo for switching AP mode and client mode of wifi

It is suitable for dhcpcd managed network on Raspbian.
It is suitable for dhcpcd managed network on Raspberry Pi OS.

Component of project are;
- dhcpcd
- dnsmasq
- hostapd
- wpa_supplicant

# Installation
```
sudo chmod +x ./install.sh
sudo ./install.sh
```

# Configuration
Change the configs on source_config file with your preferred values. You can get help from example values.

# Usage
To switch to AP mode:
```
Expand All @@ -19,7 +28,21 @@ To switch to client mode:
sudo ./switch_client_mode.sh
```

# Uninstallation
To run test_server
```
sudo python3 test_server.py
```

# Full Usage Scenario
- Change source_config files with your values
- Switch AP mode
- Run the test_server
- Connect the wifi access point by uisng another device
- Type static_ip_address or domain and view the test server on your device.



# Uninstallation
```
sudo chmod +x ./uninstall.sh
sudo ./uninstall.sh
Expand Down

0 comments on commit 8959f2e

Please sign in to comment.