summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
2023-06-06Fix up READMEGunnar Mills1-7/+6
AngularJS is end of life, correct that. Recommend switching from phosphor-webui. Further minor README improvements. Change-Id: I5067a9b5c6fc775bfa684fa1af4cb9a8142629dc Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2022-12-08prettier: re-formatPatrick Williams1-10/+20
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>
2020-10-09Update ReadmeGunnar Mills1-4/+19
Add webui-vue features not in phosphor-webui. Point at GitHub Issues label:phosphor-webui-feature-parity for feature parity. Add recent mailing list discussion and point at commit moving to webui-vue as an example. Change-Id: Ida9631c7ed8a4485f3bced34894c89eb3cca71b5 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-07-30README: Update to stronger recommend webui-vueGunnar Mills1-5/+3
webui-vue is nearing feature parity. Update the list of outstanding features and no longer recommend phosphor-webui. Change-Id: I0d1f0de74626c22db4924ca2a75e8dbd3aed9423 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-06-02Update contributing fileDerick Montague1-52/+4
- Move setup information from readme to contributing file - Add information about participating in user research - Explain the design reviews and help wanted projects - Explain how to ask questions, submit bugs and add new feature requests - Add link to OpenBMC code of conduct - Explain how to submit code for review Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: Ia2f5a59329e52bcc44a0f48bef8bbf0d97270eba
2020-05-20Update readme with new feature parity deadline exceptionYoshie Muranaka1-1/+5
Signed-off-by: Yoshie Muranaka <yoshiemuranaka@gmail.com> Change-Id: Ie6250ad99e3ae934a082b97ef30a33791f20b491
2020-02-12Update README.mdDerick Montague1-12/+20
- Fix docs script typo - Add .env file info - Update section level header hierarchy Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I0f060b89913d516f93df36c75fe3e912ea08b4bd
2020-02-08Add coding guidelines and component documentationDerick Montague1-0/+11
Resubmitting after reverted–original commit here https://gerrit.openbmc-project.xyz/c/openbmc/webui-vue/+/28760 - Update README to include instructions on documentation development - Update vue and vue-template-compiler to be compatible with vuepress Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I72049a5888ef6bea6621d0b7948f57a8e4177666
2020-01-29Revert "Add coding guidelines and component documentation"Gunnar Mills1-15/+0
Merged accidentally. Did not have proper +1s/+2s. The author will resubmit. Apologies for the noise. This reverts commit aae4312c3c535253b2d5db7a75503f0237ae423e. Change-Id: I110dd4e12286836aedf84dfba2c4ef07cac08b46 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-01-29Add coding guidelines and component documentationDerick Montague1-0/+15
- Add deploy script to create and deploy dist file to gh-pages branch - Update README to include instructions on documentation development and deployment - Update vue and vue-template-compiler to be compatible with vuepress - Set vue-date-fns to use specific version - Add shell pages to be completed later Signed-off-by: Derick Montague <derick.montague@ibm.com> Change-Id: I2fdae06d53c298d45f7a638e8875717a47050dbf
2020-01-17Update readme to include vue scriptsDerick Montague1-0/+30
Change-Id: I208dbd050a3cc2c048e297723be0f3af77323fde Signed-off-by: Derick Montague <derick.montague@ibm.com>
2020-01-17Add READMEGunnar Mills1-0/+32
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 <gmills@us.ibm.com>