From 7cc968f7e7c7e424b58370512ca5008ef67055c9 Mon Sep 17 00:00:00 2001 From: kclod kim <93501920+kclod-kim@users.noreply.github.com> Date: Mon, 4 Mar 2024 19:40:32 +0900 Subject: [PATCH 1/3] Update README file :Release Notes: Update README file :Detailed Notes: Update information of @webosose/ares-cli :Testing Performed: 1. Checked CLI unit test 2. Checked API unit test 3. Checked README file :Issues Addressed: [WRQ-9026] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3116f2d..51d8846 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # ares-cli -## Summary +> [!WARNING] +> **We moved to [@webos-tools/cli](https://github.com/webos-tools/cli).** In the future, we plan to develop and maintain a single webOS CLI to support multi webOS in @webos-tools/cli. This repository has been deprecated since March 4, 2024. **ares-cli** is a command-line interface (CLI) for webOS. It provides a collection of commands used for creating, packaging, installing, and launching apps or services in the command line environment. ares-cli lets you develop and test apps or services without using any IDE. From 1eee7fe595f7131589db9c05b3c390b993d4e694 Mon Sep 17 00:00:00 2001 From: Adolf8802 Date: Mon, 20 Apr 2026 22:49:15 +0000 Subject: [PATCH 2/3] Initial commit From b84bef820dfd8844e759c8a3c4f27a8ece7a10aa Mon Sep 17 00:00:00 2001 From: Adolf8802 Date: Fri, 24 Apr 2026 07:23:40 +0200 Subject: [PATCH 3/3] Remove default configurations and test usages from README Removed default configuration table and test usage examples from README. --- README.md | 113 +----------------------------------------------------- 1 file changed, 1 insertion(+), 112 deletions(-) diff --git a/README.md b/README.md index 51d8846..808b9a8 100644 --- a/README.md +++ b/README.md @@ -63,116 +63,5 @@ You can test the ares-cli commands and their options to check their validity. Th The following key-value pairs are the default configurations for the test. -| Key | Value | -|--------|-----------| -| device | emulator | -| ip | 127.0.0.1 | -| port | 6622 | +192.168.178.27 -### Test Usages - -- Test with default configurations. - - ``` shell - $ jasmine - ``` - - or - - ``` shell - $ jasmine device=emulator, ip=127.0.0.1, port=6622 - ``` - -- Test with specific configurations. (It can be omitted when using port 22.) - - ``` shell - $ jasmine --device=webOS --ip=192.168.0.12 - ``` - -- Test with specific port configurations. - - ``` shell - $ jasmine --device=webOS --ip=192.168.0.12 --port=24 - ``` - -- Test ares-generate command. - - ``` shell - $ jasmine --device=webOS --ip=192.168.0.12 --port=24 spec/jsSpec/ares-generate.js - ``` - -- Test using npm command `npm test` instead of `jasmine`. - - ``` shell - $ npm test --device=webOS --ip=192.168.0.12 --port=24 - ``` - -## Contributing - -The step-by-step guide to contribute is as follows: - -1. Fork: Fork source from ares-cli repository. -2. Create a new branch: Create a branch from develop branch. -3. Implement: Implement the source codes and `git push` the changes to the new branch. -4. Create a pull request: Create a pull request. When you write a commit message, make sure you follow [Commit Message Guidelines](#commit-message-guidelines). -5. Submit the pull request to the owner. - -### Commit Message Guidelines - -The following is an example of the commit message. - -``` md -Change ares-device-info to ares-device - -:Release Notes: -Expand the scope of ares-device-info command by changing its name - -:Detailed Notes: -For now, the scope of the ares-device-info command seems to narrow, -so it is hard to add other options to the command (such as capture) -- Rename ares-device-info.js to ares-device.js -- Add --system-info and --session-info options -- Update ares-device TC - -:Testing Performed: -1. All unit test passed -2. ESLint done -3. Check the below commands - $ ares-device - $ ares-device --system-info - $ ares-device --session-info - -:Issues Addressed: -[ISSUE-1] Change ares-device-info to ares-device -``` - -- Summary: Describe a summary of the pull request. Make sure you capitalize the first letter of the summary. -- Release Notes: Describe what this commit implements. -- Detailed Notes: Describe the problems of this commit and how to fix them. -- Testing Performed: Describe detailed descriptions of the testing you performed. - - Unit test: Run CLI unit test via `jasmine` on the target device or emulator and write the result. All unit tests must be passed. - - ESlint: Run `eslint` on ares-cli root directory and write the result. No warning/error would be allowed. - - Detail test steps with CLI commands : Write the commands to verify your changes. Be sure that the maintainers can check the changes by running that commands. -- Issues Addressed: Write an issue number and its summary. - -## Copyright and License Information - -Unless otherwise specified, all content, including all source code files and documentation files in this repository are: - -Copyright (c) 2020-2023 LG Electronics, Inc. - -All content, including all source code files and documentation files in this repository except otherwise noted are: - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - -SPDX-License-Identifier: Apache-2.0