RanchiMall/standard-ui
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
tripathyr 2021-07-06 13:52:04 +05:30 committed by GitHub
parent 329e879152
commit c9d7b32929
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,7 +1,13 @@
# Standard Visual Design System
### To start, pick one layout among different layouts we have provided in Layouts folder. Every layout is like approved stand-alone HTML visual template on which UI functionality needs to be added. Then add components.js from Standard UI Components folder. This will give access to functional visual elements in your layout template page. Then you can add the rest of functionality
### How to use Standard Visual Design System - A summary: Pick a layout you need, add components.js to it, then use notification sounds if your project has sound based notification
### To use Standard UI Components, Go to Standard UI Components folder, and link or add components.js to your project. Read the detailed documentation inside the Standard UI Components for instructions on how to use
#### To start, pick one layout among different layouts we have provided in Layouts folder. Every layout is like approved stand-alone HTML visual template on which UI functionality needs to be added. Then add components.js from Standard UI Components folder. This will give access to functional visual elements in your layout template page. Then you can add the rest of functionality
### aggregate.js contains all common visual js used in RanchiMall projects. These are for reference only. Users should use components.js inside Standard UI Components folder
#### We provide four kinds of layouts: A webpage which is box based, a webpage which is tab based, a webpage which has many sections, and a webpage which has sidebars. Depending upon the web project you are doing, pick one of the layouts. Picking the layout is the first task in usage of RanchiMall Standard Visual Design System. You can customize the base layouts with your own colour scheme.
#### To use Standard UI Components, Go to Standard UI Components folder, and link or add components.js to your project. Read the detailed documentation inside the Standard UI Components for instructions on how to use
#### aggregate.js contains all common visual js used in RanchiMall projects. These are for reference only. Users should use components.js inside Standard UI Components folder
#### We also provide notification sounds which are approved sound files for RanchiMall applications. These are available in Notification Sounds folder.