Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

Commit

Permalink
chore: should close #20
Browse files Browse the repository at this point in the history
  • Loading branch information
gh-alcadica committed Jun 22, 2018
1 parent 43eb315 commit acebd64
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 15 deletions.
7 changes: 7 additions & 0 deletions data/com.github.alcadica.develop.appdata.xml.in
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@
</p>
</description>
<releases>
<release version="0.0.6" date="2018-06-23">
<description>
<ul>
<li>Fills generated README.md files with installing and compiling instructions</li>
</ul>
</description>
</release>
<release version="0.0.5" date="2018-06-02">
<description>
<ul>
Expand Down
53 changes: 52 additions & 1 deletion data/templates/app/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,52 @@
# {{projectname}}
# {{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
```
38 changes: 25 additions & 13 deletions data/templates/switchboard-widget/README.md
Original file line number Diff line number Diff line change
@@ -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
```
33 changes: 32 additions & 1 deletion data/templates/wingpanel-widget/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# {{projectname}} wingpanel indicator
# {{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
```
6 changes: 6 additions & 0 deletions debian/changelog
Original file line number Diff line number Diff line change
@@ -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 <[email protected]> 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)
Expand Down

0 comments on commit acebd64

Please sign in to comment.