Create README.md

This commit is contained in:
rchac 2020-10-02 09:44:48 -06:00 committed by GitHub
parent 20c021036d
commit 8809218f34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

40
README.md Normal file
View File

@ -0,0 +1,40 @@
# LibreQoS
## Requirements
* Recent Linux kernel
* tc (available via package iproute2)
* Cake
git clone https://github.com/dtaht/sch_cake.git
cd sch_cake
make; sudo make install
## Features
* Download
* Upload
* Ping
* Jitter
* IP Address, ISP, distance from server (optional)
* Telemetry (optional)
* Results sharing (optional)
* Multiple Points of Test (optional)
## Server requirements
* 8GB RAM or more recommended
## License
Copyright (C) 2020 Robert Chacon
LibreQoS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
Foobar is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with LibreQoS. If not, see <http://www.gnu.org/licenses/>.