-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
minimal working version of the app (read only)
Because of limitations in the PHP API, this version of the app is exclusively read only. You can log in to your account, scroll through your autofinger levels, read any plan from those lists, read your own plan, and enter a plan name to finger. Lots and lots of stability issues remain. I have begun to document them in the issue tracker. Please add other entries as you see fit.
- Loading branch information
1 parent
ce038a3
commit 821a11d
Showing
7 changed files
with
1,605 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,77 @@ | ||
# GrinnellPlans-kivy | ||
A Kivy app for interfacing with GrinnellPlans | ||
GrinnellPlans-kivy | ||
================== | ||
|
||
A [Kivy app](https://www.kivy.org "Kivy's Homepage") for interfacing with [GrinnellPlans](https://github.com/grinnellplans/grinnellplans-php/ "GrinnellPlan's Code Repo") | ||
|
||
Liscensing | ||
---------- | ||
|
||
Following the current Plans codebase, this code is released under [GPL v. 3](http://www.gnu.org/licenses/gpl.txt): | ||
|
||
This program 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 3 of the License, or | ||
(at your option) any later version. | ||
|
||
This program 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 this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
Roadmap | ||
------- | ||
|
||
|
||
|
||
Contributing | ||
------------ | ||
|
||
Submit bugs and ideas to `[heider]` on Plans or via [this repo's issues page](https://github.com/paulheider/GrinnellPlans-kivy/issues) | ||
|
||
Building from Source | ||
-------------------- | ||
|
||
### Android | ||
|
||
Android compatible versions can be built with [Buildozer](https://github.com/kivy/buildozer "Buildozer's Code Repo") using the included `buildozer.spec` file: | ||
|
||
```bash | ||
## Build a deployable APK | ||
buildozer android_new debug | ||
|
||
## Build and deploy an APK to a connected device | ||
buildozer android_new debug deploy | ||
|
||
## Build, deploy, and run an APK to a connected device | ||
buildozer android_new debug deploy run | ||
``` | ||
|
||
#### Permissions | ||
|
||
1. Internet | ||
|
||
Internet access is necessary to login, pull the autofinger lists, and pull plans from the Plans database | ||
|
||
2. USB Storage | ||
|
||
The app saves configuration details locally, which requires read/modify/delete permissions. | ||
|
||
|
||
### iOS | ||
|
||
(untested) | ||
|
||
### Linux | ||
|
||
The application can be run from the terminal on a linux machine: | ||
|
||
```bash | ||
python main.py | ||
``` | ||
|
||
### Windows | ||
|
||
(untested) |
Oops, something went wrong.