From 8c4d675e1f5bee0e9d66ede1a03b31eec05fc385 Mon Sep 17 00:00:00 2001 From: Adphi Date: Sat, 19 Jan 2019 21:00:53 +0100 Subject: [PATCH] Updated README.md --- README.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 973b42a..1b9d888 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# Test Nextcloud App +# OCCWeb terminal + +A web terminal for admins to launch Nextcloud's occ commands + + Place this app in **nextcloud/apps/** ## Building the app @@ -11,16 +15,24 @@ 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 +* 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.: +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", + "prebuild": "npm install && node_modules/bower/bin/bower install && +node_modules/bower/bin/bower update", "build": "node node_modules/gulp-cli/bin/gulp.js" } ``` @@ -28,20 +40,25 @@ The make command will install or update Composer dependencies if a composer.json ## Publish to App Store -First get an account for the [App Store](http://apps.nextcloud.com/) then run: +First get an account for the [App Store](http://apps.nextcloud.com/) +then run: make && make appstore -The archive is located in build/artifacts/appstore and can then be uploaded to the App Store. +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** +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: +Of course you can also install +[PHPUnit](http://phpunit.de/getting-started.html) and use the +configurations directly: phpunit -c phpunit.xml