forked from nus-cs2103-AY2223S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into remove-colon
- Loading branch information
Showing
6 changed files
with
139 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,9 @@ | ||
| Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob | ||
| Some code adapted from http://code.makery.ch/library/javafx-8-tutorial/ by Marco Jakob | ||
|
|
||
| Copyright by Colton Wiscombe - https://mdi.bessarabov.com/icon/food-turkey | ||
| FoodRem icon by Colton Wiscombe - https://materialdesignicons.com/icon/food-turkey | ||
| - foodrem.png | ||
| - foodrem.ico | ||
|
|
||
| Copyright by Jan Jan Kovařík - http://glyphicons.com/ | ||
| - calendar.png | ||
| - edit.png | ||
|
|
||
| Website: | ||
| - Fonts by Google Fonts - https://fonts.google.com/ | ||
| - Icons from Font Awesome - https://fontawesome.com/ | ||
| - Icons by Font Awesome - https://fontawesome.com/ | ||
| - Icons by Octicons - https://primer.style/octicons/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,48 @@ | ||
| acknowledgements: >- | ||
| acknowledgements: |- | ||
| FoodRem is a brownfield software project based off [AddressBook Level-3](https://se-education.org/addressbook-level3/), taken under the [CS2103T Software Engineering module](https://nus-cs2103-ay2223s1.github.io/website/index.html) held by the School of Computing at the National University of Singapore. | ||
| Java dependencies: | ||
| * [Jackson](https://github.com/FasterXML/jackson) for JSON-related operations | ||
| * [JavaFX](https://openjfx.io/) for GUI | ||
| * [JUnit5](https://github.com/junit-team/junit5) for testing | ||
| Documentation dependencies: | ||
| * [Jekyll](https://jekyllrb.com/) for rendering the website | ||
| * [PlantUML](https://plantuml.com/) for creating UML diagrams | ||
| Fonts used in FoodRem: | ||
| * FoodRem Java App: | ||
| * [Epilogue](https://fonts.google.com/specimen/Epilogue) by Tyler Finck | ||
| * [JetBrains Mono](https://fonts.google.com/specimen/JetBrains+Mono) by Philipp Nurullin and Konstantin Bulenkov | ||
| * [Montserrat](https://fonts.google.com/specimen/Montserrat) by Julieta Ulanovsky et al. | ||
| * FoodRem Website: | ||
| * [Epilogue](https://fonts.google.com/specimen/Epilogue) by Tyler Finck | ||
| * [Source Code Pro](https://fonts.google.com/specimen/Source+Code+Pro) by Paul D. Hunt | ||
| Other acknowledgments: | ||
| * Material Design Icons: | ||
| * [food-turkey](https://materialdesignicons.com/icon/food-turkey) by Colton Wiscombe as FoodRem's App Icon | ||
| * Font Awesome 6 icons: | ||
| * [book](https://fontawesome.com/icons/book) as the "note" admonition icon | ||
| * [circle-info](https://fontawesome.com/icons/circle-info) as the "info" admonition icon | ||
| * [fire-flame-curved](https://fontawesome.com/icons/fire-flame-curved) as the "danger" admonition icon | ||
| * [lightbulb](https://fontawesome.com/icons/lightbulb) as the "tip" admonition icon | ||
| * [triangle-exclamation](https://fontawesome.com/icons/triangle-exclamation) as the "warning" admonition icon | ||
| * Octicons: | ||
| * [git-merge](https://primer.style/octicons/git-merge-16) for the PR badge used in the project PPPs | ||
| * [issue-closed](https://primer.style/octicons/issue-closed-16) for the issue badge used in the project PPPs | ||
| * Code acknowledgements: | ||
| * [Custom link fragment checker](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/cli-test/linkchecker/check-links.js) adapted from the [World Wide Web Consortium](https://github.com/w3c/node-linkchecker) | ||
| * [Pure CSS auto-incrementing heading counters](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/toc.scss) adapted from [@gvgramazio on StackOverflow](https://stackoverflow.com/a/51007932/9311854) | ||
| * [PDF styling of HTML pages](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/pdf.scss) following Michael Perrin's [tutorial](https://www.michaelperrin.fr/blog/2019/11/printing-the-web-part-2-html-and-css-for-printing-books) | ||
| * [Pure liquid admonitions](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_sass/admonitions.scss) adapted from [@kimkyunghwan21 on GitHub](https://github.com/kimkyunghwan21/kimkyunghwan21.github.io/blob/master/_layouts/plugins/extension.liquid) | ||
| * [Pure liquid HTML table-of-contents](https://github.com/AY2223S1-CS2103T-W16-2/tp/blob/master/docs/_includes/toc.html) from [@allejo on GitHub](https://github.com/allejo/jekyll-toc) | ||
| * Miscellaneous: | ||
| * [Docusaurus](https://docusaurus.io/docs/markdown-features/admonitions) for admonition colors and styling | ||
| * [GitHub](https://github.com) for "PR merged" and "issue closed" colors used in PPP badges | ||
| * [SchemeColor](https://www.schemecolor.com/pastel-rainbow.php) for admonition colors | ||
| about: | ||
| summary: >- | ||
| summary: |- | ||
| FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. As a restaurant manager, you can easily view and edit your inventory during your daily operations. Utilize FoodRem's flexible **tagging system** to help you organize your inventory according to your business needs. Finally, streamline your business decisions by deriving insights from your inventory usage through FoodRem's **statistics** -- you can keep track of metrics such as food wastage amount if you wish! | ||
| summary_dg: >- | ||
| summary_dg: |- | ||
| FoodRem is an **Inventory Management System** that empowers small food and beverage (F&B) restaurant managers to manage inventory and obtain insights from inventory data. Users can leverage FoodRem's **Inventory Management System** to view and edit their inventory during daily operations. FoodRem's **tagging system** helps users organize their inventory according to their business needs. FoodRem also derives insights from inventory usage through its **statistics**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,3 @@ | ||
| <!--markdownlint-disable-file first-line-h1 --> | ||
| <!-- markdownlint-disable-next-line proper-names --> | ||
| {{ site.data.foodrem.acknowledgements }} | ||
|
|
||
| * Libraries used: [Jackson](https://github.com/FasterXML/jackson), [JavaFX](https://openjfx.io/), [Jekyll](https://jekyllrb.com/), [JUnit5](https://github.com/junit-team/junit5), [PlantUML](https://plantuml.com/) | ||
| * Icons used: Icons for [FoodRem](https://mdi.bessarabov.com/icon/food-turkey), [admonitions](http://glyphicons.com/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,3 @@ | ||
| <!-- markdownlint-disable-file first-line-h1 --> | ||
| <!-- markdownlint-disable-next-line proper-names --> | ||
| {{ site.data.foodrem.acknowledgements }} | ||
|
|
||
| * Libraries used: [Jackson](https://github.com/FasterXML/jackson), [JavaFX](https://openjfx.io/), [Jekyll](https://jekyllrb.com/), [JUnit5](https://github.com/junit-team/junit5), [PlantUML](https://plantuml.com/) | ||
| * Icons used: [FoodRem Logo](https://mdi.bessarabov.com/icon/food-turkey), [Admonition Icons](http://glyphicons.com/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters