Skip to content

Commit

Permalink
Increse version, add Screenshot and also use Office category
Browse files Browse the repository at this point in the history
  • Loading branch information
matiasdelellis committed Aug 29, 2018
1 parent ff49f20 commit 4995a07
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 49 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## [0.1.4]: 2018-08-29
### Added
- Some styles fixed.

## [0.1.3]: 2018-04-26
### Added
- Some styles fixed.
Expand Down
56 changes: 8 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,12 @@
# Quick Notes
Place this app in **owncloud/apps/**
# Quick notes

## Building the app
The Quick notes application, is an application to take quick notes -Forgive the
redundancy :sweat_smile:- on small cards, organizedby colors -And in future
categories-. It allows a basic rich text as **Bold**, *italic*, and numbered or
bullet list, to improve the notes.

The app can be built by using the provided Makefile by running:
![App screenshots](/doc/quicknotes-screenshot.png "App screenshots")

make
## Instalation

This requires the following things to be present:
* make
* which
* tar: for building the archive
* curl: used if phpunit and composer are not installed to fetch them from the web
* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder

The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.:

**package.json**:
```json
"scripts": {
"test": "node node_modules/gulp-cli/bin/gulp.js karma",
"prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
"build": "node node_modules/gulp-cli/bin/gulp.js"
}
```


## Publish to App Store

First get an account for the [App Store](http://apps.owncloud.com/) then run:

make appstore

The archive is located in build/artifacts/appstore and can then be uploaded to the App Store.

## Running tests
You can use the provided Makefile to run all tests by using:

make test

This will run the PHP unit and integration tests and if a package.json is present in the **js/** folder will execute **npm run test**

Of course you can also install [PHPUnit](http://phpunit.de/getting-started.html) and use the configurations directly:

phpunit -c phpunit.xml

or:

phpunit -c phpunit.integration.xml

for integration tests
Quick notes is available in the Nextcloud App Store and can be installed directly from your Nextcloud installation looking in the category Office.
3 changes: 2 additions & 1 deletion appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
<description>Quick notes with a basic rich text</description>
<licence>AGPL</licence>
<author>Matias De lellis</author>
<version>0.1.3</version>
<version>0.1.4</version>
<namespace>QuickNotes</namespace>
<category>office</category>
<category>tools</category>
<website>https://github.com/matiasdelellis/quicknotes</website>
<bugs>https://github.com/matiasdelellis/quicknotes/issues</bugs>
Expand Down
Binary file added doc/quicknotes-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4995a07

Please sign in to comment.