Mirrors/tabler
1
0
Fork 0
mirror of https://github.com/tabler/tabler.git synced 2025-12-26 11:16:12 +04:00
Code Issues Projects Releases Wiki Activity

readme fixes

Browse Source
This commit is contained in:
codecalm
2018-02-22 22:17:50 +01:00
parent 46b3aba79e
commit c59a34067c
1 changed files with 14 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -22,7 +22,6 @@
- [About Tabler](#about-tabler)
- [Getting Started](#getting-started)
- [Status](#status)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Contributing](#contributing)
- [Browser Support](#browser-support)
@@ -41,7 +40,7 @@ To make the system works fast and reliable, we've converted most of the componen
## Getting Started
### 1. [Download ZIP](https://github.com/tabler/tabler/archive/master.zip) or Git Clone
### 1. [Download ZIP](https://github.com/tabler/tabler/archive/dev.zip) or Git Clone
```
git clone https://github.com/tabler/tabler.git
@@ -49,27 +48,24 @@ git clone https://github.com/tabler/tabler.git
### 2. Build the project
The cloned/downloaded repository doesn't contain prebuilt version of the project and you need to build it. You need to have [NodeJs](https://nodejs.org/en/) with npm installed.
**Setup environment**
Install npm dependencies
```
npm install
```
To use our build system and run our documentation locally, you'll need a copy of Tabler's source files and Node. Follow these steps:
Build the project and start local web server
```
jekyll serve
```
1. [Download and install Node.js](https://nodejs.org/download/), which we use to manage our dependencies.
2. Navigate to the root `/tabler` directory and run `npm install` to install our local dependencies listed in `package.json`.
3. [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/), install [Bundler](https://bundler.io/) with `gem install bundler`, and finally run `bundle install`. This will install all Ruby dependencies, such as Jekyll and plugins.
- **Windows users:** Read [this guide](https://jekyllrb.com/docs/windows/) to get Jekyll up and running without problems.
When completed, you'll be able to run the various commands provided from the command line.
Open the project [http://localhost:4000](http://localhost:4000).
**Build Tabler locally**
**Warning!** all changes made in ```dist/``` folder would be overwriten on application build.
1. From the root `/tabler` directory, run `npm run serve` in the command line.
2. Open [http://localhost:4000](http://localhost:4000) in your browser, and voilà.
3. Any change in `/src` directory will build application and refresh the page.
## Status
![Build Status](https://app.buddy.works/codecalm/tabler/pipelines/pipeline/125783/badge.svg?token=1ab151000ecf8700a90dd4d0d7184945d439d2642679b257092d16e76a45dce4)
![CSS gzip size](http://img.badgesize.io/tabler/tabler/dev/dist/assets/css/dashboard.min.css?compression=gzip&label=CSS+gzip+size)
**Warning!** all changes made in `_site/` folder would be overwriten on application build.
## Bugs and feature requests