Skip to content

contributions.md

Latest commit

 

History

History
23 lines (17 loc) · 2.26 KB

contributions.md

File metadata and controls

23 lines (17 loc) · 2.26 KB

How to Contribute to Terbium v2

Table of Contents

Understanding the File Structure

Terbium v2 for the most part is written in React. If you haven't already make sure you have all the dependencies installed which can be done via pnpm i (or the package manager of your choice).

Terbium has 3 Folders that you should pay attention to and that are referenced throughout Terbium's Code.

  • src: The location of the webOS's frontend code & apis Such as the login, desktop, gui components etc

    • sys: The location of the APIs and GUI components/styles
      • gui: The location of GUI Components
        • styles: Stylesheets for all the components
      • liquor: The location of all liquor related components and APIs
      • apis: The location of the API's code

  • public: The static folder for normal html, js, css components such as Default Applications, Libraries, and Anura Applications & Service Workers

Learning What should and shouldn't be touched

For the most part this is self explanatory. Unless you absolutely know what your doing DO NOT mess with anything in the sys folder or any typescript configuration files as they are system critical and will break things if you modify them without knowing what you're doing. If you do however know what you're doing and wish to expand upon the current functionality feel free to poke around in the sys.

Modifying apps in the public folder is fine and shouldn't break anything since it is not system dependent except for in the OOBE when it copies assets from there to the file system. If you wish to add Terminal Commands refer to Creating Terminal Commands