mirror of
https://github.com/JanGross/quicknotes.git
synced 2025-11-30 23:37:16 +01:00
Increse version, add Screenshot and also use Office category
This commit is contained in:
@@ -1,3 +1,7 @@
|
||||
## [0.1.4]: 2018-08-29
|
||||
### Added
|
||||
- Some styles fixed.
|
||||
|
||||
## [0.1.3]: 2018-04-26
|
||||
### Added
|
||||
- Some styles fixed.
|
||||
|
||||
56
README.md
56
README.md
@@ -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:
|
||||

|
||||
|
||||
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.
|
||||
@@ -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>
|
||||
|
||||
BIN
doc/quicknotes-screenshot.png
Normal file
BIN
doc/quicknotes-screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Reference in New Issue
Block a user