summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-12-08 15:13:13 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-12-08 15:13:13 +0300
commit7385e139b0c9efca7430458cee982e63e282f4ae (patch)
tree1bbdb0164e556b76eec72cb558c66974c8f95dd8 /README.md
parentb24a483eda5ca0b0ecdb4f0c61b90d76d0d8e1e0 (diff)
downloadwebui-vue-7385e139b0c9efca7430458cee982e63e282f4ae.tar.xz
prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML files to have consistent formatting for these file types. Re-run the formatter on the whole repository. Change-Id: I2804ee3ab5ff6bcbf986b028db2fafec8e616779 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 20 insertions, 10 deletions
diff --git a/README.md b/README.md
index efde8673..80da456d 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,14 @@ webui-vue is a web-based user interface for the OpenBMC firmware stack built on
## Hold on... What happened to phosphor-webui?
[phosphor-webui](https://github.com/openbmc/phosphor-webui) was built on
-AngularJS and [AngularJS goes End of Life](https://www.convective.com/angularjs-end-of-life/)
+AngularJS and
+[AngularJS goes End of Life](https://www.convective.com/angularjs-end-of-life/)
June 30, 2021, this repository is its replacement.
## When will this new Vue.js application reach feature parity with phosphor-webui?
-Several, mostly minor, features remain for feature parity. See [GitHub Issues label:phosphor-webui-feature-parity](
-https://github.com/openbmc/webui-vue/issues?q=is%3Aissue+is%3Aopen+label%3Aphosphor-webui-feature-parity)
+Several, mostly minor, features remain for feature parity. See
+[GitHub Issues label:phosphor-webui-feature-parity](https://github.com/openbmc/webui-vue/issues?q=is%3Aissue+is%3Aopen+label%3Aphosphor-webui-feature-parity)
for the complete list.
## Why will this application be better?
@@ -27,24 +28,33 @@ anti-patterns that exist in phosphor-webui today.
## Should I switch to webui-vue from phosphor-webui?
That is up to you. Several companies have switched.
+
- [Commit moving several systems to webui-vue](https://github.com/openbmc/openbmc/commit/4a3fa4d6d865b46ba54f2652c82f58a406455ebc)
- [Discussion about webui-vue being the standard](https://lists.ozlabs.org/pipermail/openbmc/2020-September/023160.html)
-webui-vue although still missing a few features that were in
-phosphor-webui, as mentioned above, has the following additional features:
+webui-vue although still missing a few features that were in phosphor-webui, as
+mentioned above, has the following additional features:
+
- Ability to easily theme to meet brand guidelines
- Accessibility
- Full Redfish
- Improved user experience based on user feedback
- Language translation-ready
- Modern front-end framework with an active community and future development
-roadmap
+ roadmap
## How can I get involved?
-- Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute code
-- Review some code in [Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open)
-- Join us in the [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
+- Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute
+ code
+- Review some code in
+ [Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open)
+- Join us in the
+ [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
## Documentation
-The documentation for coding standards and components is located in the `docs` directory. It is created using the [VuePress](https://vuepress.vuejs.org/) static site generator. Information about how to write documentation can be found on the [VuePress website](https://vuepress.vuejs.org/).
+
+The documentation for coding standards and components is located in the `docs`
+directory. It is created using the [VuePress](https://vuepress.vuejs.org/)
+static site generator. Information about how to write documentation can be found
+on the [VuePress website](https://vuepress.vuejs.org/).