Merge pull request #369 from lakinduakash/lakinduakash-patch-3

Update README.md
This commit is contained in:
Lakindu Akash 2024-01-01 21:48:11 +05:30 committed by GitHub
commit c84849807d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,10 +6,11 @@
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Flakinduakash%2Flinux-wifi-hotspot.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Flakinduakash%2Flinux-wifi-hotspot?ref=badge_shield)
### What's new
* Use aa-complain instead of complain to fix permission issue for dnsmasq
* Use aa-complain instead of complain to fix the permission issue for dnsmasq
* Fix some 5Ghz band not working issue
* Compatible with iw 6.7
#### Thank you for all the contributions made while I'm not active on this repository.
#### Thank you for all the contributions made while I was not active on this repository.
### Features
@ -19,7 +20,7 @@
* Share wifi via QR code
* MAC filter
* View connected devices
* Includes Both command line and gui.
* Includes Both command line and GUI.
* Support both 2.4GHz and 5GHz (Need to be compatible with your wifi adapter). Ex: You have connected to the 5GHz network and share a connection with 2.4GHz.
* Customise wifi Channel, Change MAC address, etc.
* Hide SSID
@ -33,11 +34,11 @@
Read [Command line help and documentation here](src/scripts/README.md).
If you only need the command-line without GUI run `make install-cli-only` as root user.
If you only need the command line without GUI run `make install-cli-only` as the root user.
### Notes
- Sometimes there are troubles with **5Ghz bands** due to some vendor restrictions. If you cannot start hotspot while you are connected to 5Ghz band, Unselect **Auto** and select **2.4Ghz** in frequency selection.
- Sometimes there are troubles with **5Ghz bands** due to some vendor restrictions. If you cannot start the hotspot while you are connected to the 5Ghz band, Unselect **Auto** and select **2.4Ghz** in frequency selection.
- If any problems with **RealTeK Wifi Adapters** see [this](docs/howto/realtek.md)
@ -47,14 +48,13 @@ If you only need the command-line without GUI run `make install-cli-only` as roo
## Installation
#### Debian/Ubuntu (Outdated)
#### Debian/Ubuntu
Download the debian package from latest [release](https://github.com/lakinduakash/linux-wifi-hotspot/releases/latest)
Download the Debian package from the latest [release](https://github.com/lakinduakash/linux-wifi-hotspot/releases/latest)
**OR**
Please don't use following for ubuntu since I lost keys and package is outdated. I'll fix it ASAP
Good news! I was able to restore keys, new versions will be available via the PPA
```bash
# For ubuntu - package outdated due to lost GPG keys
sudo add-apt-repository ppa:lakinduakash/lwh
sudo apt install linux-wifi-hotspot
@ -62,7 +62,7 @@ sudo apt install linux-wifi-hotspot
#### Arch based distributions
Linux Wifi Hotspot is available as an [AUR package](https://aur.archlinux.org/packages/linux-wifi-hotspot/). You can install it manually or with your favourite AUR helper.
Linux Wifi Hotspot is available as an [AUR package](https://aur.archlinux.org/packages/linux-wifi-hotspot/). You can install it manually or with your favorite AUR helper.
For example, if you use `yay` you can do:
`yay -S linux-wifi-hotspot`
@ -96,7 +96,7 @@ install it using your distro's package manager_
* libqrencode-dev (for qr code generation)
* libpng-dev (for qr code generation)
On Ubuntu or debian install dependencies by,
On Ubuntu or Debian install dependencies by,
```bash
sudo apt install -y libgtk-3-dev build-essential gcc g++ pkg-config make hostapd libqrencode-dev libpng-dev
@ -137,7 +137,7 @@ After connecting to VPN, Open `wihotspot` GUI. Select the virtual interface crea
## Run on Startup
The `wihotspot` GUI uses `create_ap` to create and manage access points. This service and core logic was originally created by
The `wihotspot` GUI uses `create_ap` to create and manage access points. This service and core logic were originally created by
[@oblique](http://github.com/oblique), and are now maintained in this
repository.
@ -151,7 +151,7 @@ Start the hotspot service on startup (using your saved configuration) with:
## Contributing
If you found a bug or you have an idea about improving this make an issue. Even a small contribution make open source world more beautiful.
If you found a bug or you have an idea about improving this make an issue. Even a small contribution makes the open source world more beautiful.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
## Disclaimer