laudom
/
librefi
2
0
Fork 0
Code Issues 15 Pull Requests Packages Projects Releases Wiki Activity

readme update: python 3.4+ and jython supported

master
Laura Liberda 2020-12-03 07:40:36 +01:00
parent 710cf70140
commit dadab6e8f5
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,30 +1,40 @@
# LibreFi
## Free Wi-Fi was so great that we created Free Wi-Fi 2
Note: work is still in progress, this is not stable, may not be usable or useful
## How to use (for now):
## How to use:
release (not to be confused with: _stable_):
```sh
# you may want to use python3.9, python2, python, jython or something like that
$ python3 -m pip install librefi
$ python3 -m librefi # no daemon yet, run to connect
```
development:
```sh
$ git clone https://git.sakamoto.pl/laudom/librefi.git
$ cd librefi
$ pip3 install -r ./librefi/requirements.txt
$ pip3 install -r ./requirements.txt
$ pip3 install -r ./requirements_dev.txt
$ python3 -m librefi # no daemon yet, run to connect
```
## A bit of technical things
- Requires Python 3.8+ or 2.7
- Requires NetworkManager (only Linux and some Unix-like systems) to connect with Wi-Fi networks for now.
- Only tested with CPython for now.
- Requires Python 3.4+ or 2.7 (preferably 3.8+)
- Requires NetworkManager (only Linux and some Unix-like systems) to connect with Wi-Fi networks for now, however, it's ready to implement other connectors.
- Only tested with CPython and Jython, other implementations may work by accident.
- Only works with [these networks](https://git.sakamoto.pl/laudom/librefi/-/blob/master/librefi/fxckers/_map.py)
## Contributing
If you want to contribute, please contact with either [Laura](https://selfisekai.rocks) or [Dominika](https://sakamoto.pl) for a [git.sakamoto.pl](https://git.sakamoto.pl) account, or just [submit patches by e-mail](https://devconnected.com/how-to-create-and-apply-git-patch-files/#Create_Git_Patch_Files) to <librefi-patches@selfisekai.rocks>
If you want to contribute, please contact with either [Lauren](https://selfisekai.rocks) or [Dominika](https://sakamoto.pl) for a [git.sakamoto.pl](https://git.sakamoto.pl) account, or just [submit patches by e-mail](https://devconnected.com/how-to-create-and-apply-git-patch-files/#Create_Git_Patch_Files) to <librefi-patches@selfisekai.rocks>
## Maintainers:
### Core:
- Laura Liberda <laura@selfisekai.rocks>
- Lauren Liberda <lauren@selfisekai.rocks>
- Dominika Liberda <sdomi@sakamoto.pl>
### Fxckers:
- Poland:
- Warsaw:
- Laura Liberda <laura@selfisekai.rocks>
- Lauren Liberda <lauren@selfisekai.rocks>
- Dominika Liberda <sdomi@sakamoto.pl>