achille-martin / pyqt-crom

Create cross-platform apps (Android for now) using only Python and the Qt Framework (PyQt5 for now).
MIT License
29 stars 2 forks source link

Feature: add roadmap to README #9

Closed achille-martin closed 1 year ago

achille-martin commented 1 year ago

According to https://github.com/jonashackt/plantuml-markdown, it is possible to add a plantuml diagram to Github readme:

achille-martin commented 1 year ago

The file .iuml can be added to documentation-resources as roadmap.iuml with the content:

@startuml
start
partition Overview {
    :Articulate aim;
    note right
        Create an android app (.apk) from a simple PyQt5 app
    end note
    :Define requirements;
    note right
      Relevant for custom apps
    end note
    :Research existing projects;
    note right
        **Pyqtdeploy** / Pyside / Kivy / BeeWare
    end note
}
partition Implementation {
    :Apk generation;
    note right
      Managed by build_app.py
    end note
    :Pkg structure;
    note right
      Basic python project structure
    end note
    :SQL database;
    note right
      Managed with QtSql
    end note
    :Graphics;
    note right
      WIP
    end note    
}
partition Testing {
    :Logging;
    note right
      Basic python logging
    end note
    :Tests;
}
partition Deployment {
    :Documentation;
    :Sharing and Advertising;
}
partition Extension {
    :Windows OS;
    :Linux OS;
    :Mac OS;
}
stop
@enduml
achille-martin commented 1 year ago

Inside the README:

<a id="roadmap"></a>
## Roadmap

_This section introduces the broad roadmap for this project._

![Roadmap Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/achille-martin/simple-pyqt5-android-app/master/documentation-resources/roadmap.iuml)