diff --git a/data/com.github.alcadica.develop.appdata.xml.in b/data/com.github.alcadica.develop.appdata.xml.in index 164df5e..911a63e 100644 --- a/data/com.github.alcadica.develop.appdata.xml.in +++ b/data/com.github.alcadica.develop.appdata.xml.in @@ -16,6 +16,13 @@

+ + +
    +
  • Fills generated README.md files with installing and compiling instructions
  • +
+
+
    diff --git a/data/templates/app/README.md b/data/templates/app/README.md index 781f786..20c3069 100644 --- a/data/templates/app/README.md +++ b/data/templates/app/README.md @@ -1 +1,52 @@ -# {{projectname}} \ No newline at end of file +# {{projectname}} + +Adds your awesome app description here! + +(maybe adds a screenshot, people loves screenshots!) + +## Get it from the elementary OS AppCenter! + +[![Get it on AppCenter](https://appcenter.elementary.io/badge.svg)](https://appcenter.elementary.io/{{projectname}}) + +This app is available on the elementary OS AppCenter. + +# Install it from source + +You can of course download and install this app from source. + +## Dependencies + +Ensure you have these dependencies installed + +* granite +* gtk+-3.0 +* switchboard-2.0 + +## Install, build and run + +```bash +# install elementary-sdk, meson and ninja +sudo apt install elementary-sdk meson ninja +# clone repository +git clone {{repository_url}} {{projectname}} +# cd to dir +cd {{projectname}} +# run meson +meson build --prefix=/usr +# cd to build, build and test +cd build +sudo ninja install && {{projectname}} +``` + +## Generating pot file + +```bash +# after setting up meson build +cd build + +# generates pot file +sudo ninja {{projectname}}-pot + +# to regenerate and propagate changes to every po file +sudo ninja {{projectname}}-update-po +``` diff --git a/data/templates/switchboard-widget/README.md b/data/templates/switchboard-widget/README.md index 7b2d139..130c0c3 100644 --- a/data/templates/switchboard-widget/README.md +++ b/data/templates/switchboard-widget/README.md @@ -1,20 +1,32 @@ # {{projectname}} -## Building and Installation +## Install, build and run -You'll need the following dependencies: +```bash +# install elementary-sdk, meson and libswitchboard +sudo apt install elementary-sdk meson libswitchboard-2.0-dev +# clone repository +git clone {{repourl}} {{projectname}} +# cd to dir +cd {{projectname}} +# run meson +meson build --prefix=/usr +# cd to build, build and test +cd build +sudo ninja install +# restart switchboard to load your widget into switchboard +pkill switchboard -9 +``` -* libswitchboard-2.0-dev -* libgranite-dev -* meson -* valac +## Generating pot file -Run `meson` to configure the build environment and then `ninja` to build +```bash +# after setting up meson build +cd build - meson build --prefix=/usr - cd build - ninja +# generates pot file +sudo ninja {{projectname}}-pot -To install, use `ninja install` - - sudo ninja install +# to regenerate and propagate changes to every po file +sudo ninja {{projectname}}-update-po +``` diff --git a/data/templates/wingpanel-widget/README.md b/data/templates/wingpanel-widget/README.md index 4056c7f..1bea3e0 100644 --- a/data/templates/wingpanel-widget/README.md +++ b/data/templates/wingpanel-widget/README.md @@ -1 +1,32 @@ -# {{projectname}} wingpanel indicator \ No newline at end of file +# {{projectname}} wingpanel indicator + +## Install, build and run + +```bash +# install elementary-sdk, meson and libwingpanel +sudo apt install elementary-sdk meson libwingpanel-2.0-dev +# clone repository +git clone {{repourl}} {{projectname}} +# cd to dir +cd {{projectname}} +# run meson +meson build --prefix=/usr +# cd to build, build and test +cd build +sudo ninja install +# restart switchboard to load your indicator +pkill wingpanel -9 +``` + +## Generating pot file + +```bash +# after setting up meson build +cd build + +# generates pot file +sudo ninja {{projectname}}-pot + +# to regenerate and propagate changes to every po file +sudo ninja {{projectname}}-update-po +``` diff --git a/debian/changelog b/debian/changelog index 3196e3c..56b0ecd 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +com.github.alcadica.develop (0.6) precise; urgency=low + + * Fills generated README.md files with installing and compiling instructions + + -- Paolo Roth Tue, 23 Jun 2018 03:00:00 -0500 + com.github.alcadica.develop (0.5) precise; urgency=low * Adds a small disclaimer about user data consumption (they are not saved on a server)