From 828b40d47249954859d293b2fdb9df134fe84f20 Mon Sep 17 00:00:00 2001 From: Gunnar Mills Date: Fri, 17 Jan 2020 09:03:34 -0600 Subject: Add README Added a quick README and CONTRIBUTING file. The README contains some Questions and Answer. The CONTRIBUTING.md was inspired by https://github.com/atom/atom/blob/master/CONTRIBUTING.md Tested: https://jbt.github.io/markdown-editor/ and grammarly.com Change-Id: I6d8bc1d4a799210b7cbff66f86d4f8c1f130a1b4 Signed-off-by: Gunnar Mills --- CONTRIBUTING.md | 5 +++++ README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..cb3874d4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +Contributing to WebUI-Vue + +:+1::tada: First off, thanks for taking the time to contribute! :+1::tada: + +The following is a set of guidelines for contributing to webui-vue. diff --git a/README.md b/README.md new file mode 100644 index 00000000..197827a6 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# webui-vue + +webui-vue is a web-based user interface for the OpenBMC firmware stack built on +[Vue.js](https://vuejs.org/). + +### 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/) +June 30, 2021, so this repository is hopefully its replacement. At this time, +phosphor-webui still contains more features and you should consider using it. + +### When will this new Vue.js application reach feature parity with phosphor-webui? + +The current plan is by June 2020! + +### Why will this application be better? + +As mentioned, this application is built using Vue.js, a modern open-source +Model-View-ViewModel JavaScript framework supported by an active community and +strong documentation. It has been architected to allow organizations to easily +update the theme to support their brand. This rewrite takes advantage of +front-end development best practices and does not suffer from some of the +anti-patterns that exist in phosphor-webui today. + +### 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), +or join us in the +[GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group). -- cgit v1.2.3