diff --git a/README.md b/README.md index 35b041a3c..61d83579e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Material +# Material 2 [![Backers on Open Collective](https://opencollective.com/material/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/material/sponsors/badge.svg)](#sponsors) -> **DISCLAIMER**: This framework has been created by [Daemonite team](http://daemonite.github.io/material/). As they are not active for now, we enhance this framework until they come back to maintain the project. +> **DISCLAIMER**: This framework was created by [Daemonite team](http://daemonite.github.io/material/). Since they are not active / focused at working this framework for **now**, we will enhance this framework until they come back to maintain the project. -Daemonite's Material UI 2 is a cross-platform and fully responsive front-end interface based on Google Material Design 2 developed using Bootstrap 4. +Daemonite's Material UI 2 is a cross-platform and fully responsive front-end interface based on Google Material Design 2 developed by Google. The basic idea behind this project is to combine the front-end technology of the popular Bootstrap framework with the visual language of Google Material Design 2. @@ -18,11 +18,9 @@ The primary goal of this project is to give all Bootstrap components and element A secondary goal of this project is to add support for some unique Google Material Design components such as floating buttons, pickers, and steppers, to name a few, which cannot be achieved by transforming existing Bootstrap components. -Because these components will require additional markup (some may require additional JavaScript), they will be documented separately in Material's documentation. +Because these components will require additional markup (some may require additional JavaScript), they will be documented separately in Material's documentation. :pray: -## :pray: - -This project exists thanks to all the people who contribute. +This project exists thanks to all the people who takes time to contribute. @@ -50,12 +48,14 @@ Support this project by becoming a sponsor. Your logo will show up here with a l ## Table of contents - [Content](#content) -- [Documentation](#documentation) -- [Quick start](#quick-start) ++ [Running Documentation Locally](#running-documentation-locally) + + [End-Of-Line Issue Fix](#end-of-line-fix) + - [Command Notes](#command-notes) + * [Quick start](#quick-start) ## Content -Within the download you will find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this: +Within this repository context, you will find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this: ``` djibe-material/ @@ -71,9 +71,9 @@ djibe-material/ └── material.min.js.map ``` -We provide compiled CSS and JavaScript (`material.*`), as well as compiled and minified CSS and JavaScript (`material.min.*`). CSS and JavaScript source maps (`material.*.map`) are available for use with certain browsers' developer tools. +We provide compiled CSS and JavaScript (`material.*`), as well as compiled and minified CSS and JavaScript (`material.min.*`). CSS and JavaScript source maps (`material.*.map`) are also available for use with certain browsers' developer tools. -The Material source code download includes the precompiled CSS and JavaScript, along with documentation and source assets. More specifically, it includes the following and more: +The Material 2 source code download includes the precompiled CSS and JavaScript, along with documentation and source assets. More specifically, it includes the following and more: ``` djibe-material/ @@ -96,16 +96,38 @@ djibe-material/ ## Documentation -Material's documentation, included in this repo in the root directory, is built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages at . The docs may also be run locally. +Material's 2 documentation that is included in this repo located in the root directory, is built with [Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages at . The docs can also be hosted locally. -### Running documentation locally +### Running Documentation Locally 1. Run through the [tooling setup](http://djibe.github.io/material/docs/4.4/getting-started/tooling/#getting-started) to install Jekyll and other Ruby dependencies with `bundle install`. 2. Run `npm install` to install Node.js dependencies. 3. Run `npm run dist` and `npm run docs` to rebuild distributed CSS and JavaScript files, as well as docs assets. +4. If you had end-of-line errors when running the commands indicated in step #3 then, please follow [this step](#end-of-line-fix) before proceeding, or else proceed to step #5. 4. From the root `/material` directory, run `npm run docs-serve` in the command line. 5. Open `http://localhost:9999/material` in your browser, and voilà. +### End-Of-Line Fix +This repository is usually in CRLF end-of-line mode. When your GitHub is currently set at LF end-of-line mode automatically, there will be an error. Which shows the following: +` +Error : Expected linebreaks to be 'LF' but found CRLF +` + +This caused by working the repo in multiple OS in which, each OS has different types of string interpretation; and Node.JS doesn't like it. + +In order to fix this problem, you have to save all modified files that is not yet committed in the state of the repo and please follow the steps below: + +1. `git config core.autocrlf false` +2. `git rm --cached -r .` +3. `git reset --hard` + +#### Command Notes +* At command #1, we have to configure github to stop interpretting our files in the repo to convert the end-of-line to **CRLF**. +* At command #2, since we configured our github to stop converting those into **CRLF** where it is expected to be **LF**, we have to remove all the cache files and remove them in recursive way in the same path where your command line directory is at. (For instance, your command line target path is this repository.) +* And finally at command #3, we have to reset the state of your saved local repo by issuing `--hard` command. Where, all modified files that is not included in the latest commit of repo will be removed. + +Now try issuing commands from the recent steps earlier and *****that should work fine*****. + ## Quick start Several quick start options are available: