Skip to content

Commit f5b9dbd

Browse files
authored
Merge pull request #471 from materializecss/simplify-devprocess-and-dependecies
refactor: remove dependencies
2 parents 34aeaf3 + ccfb247 commit f5b9dbd

File tree

4 files changed

+36
-1411
lines changed

4 files changed

+36
-1411
lines changed

Gruntfile.js

-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,6 @@ module.exports = function (grunt) {
331331
grunt.loadNpmTasks('grunt-text-replace');
332332
grunt.loadNpmTasks('grunt-banner');
333333
grunt.loadNpmTasks('grunt-rename-util');
334-
grunt.loadNpmTasks('grunt-browser-sync');
335334
grunt.loadNpmTasks('grunt-contrib-jasmine');
336335
grunt.loadNpmTasks('grunt-postcss');
337336
grunt.loadNpmTasks('grunt-webpack');

README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<a href="https://materializeweb.com">
2+
<a href="https://materializeweb.com" target="_blank">
33
<img src="https://materializeweb.com/images/materialize.svg" width="200">
44
</a>
55
</p>
@@ -9,7 +9,7 @@
99
<p align="center">
1010
Materialize, a CSS Framework based on Material Design.
1111
<br>
12-
<a href="https://materializeweb.com"><strong>-- Browse the docs --</strong></a>
12+
<a target="_blank" href="https://materializeweb.com"><strong>[ Browse the docs ]</strong></a>
1313
<br>
1414
<br>
1515
<a href="https://github.com/materializecss/materialize/actions/">
@@ -37,26 +37,24 @@ Read the [getting started guide](https://materializeweb.com/getting-started.html
3737
- Include the files via [jsDelivr](https://www.jsdelivr.com/package/npm/@materializecss/materialize).
3838
- Install with [npm](https://www.npmjs.com): `npm install @materializecss/materialize` (Beta: `npm install @materializecss/materialize@next`)
3939

40-
## Documentation
41-
The documentation can be found at <https://materializeweb.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer.
40+
## Development
41+
The documentation can be found at <https://materializeweb.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org) installed on your computer.
4242

43-
### Running documentation locally
44-
Run these commands to set up the documentation:
45-
46-
```bash
47-
git clone https://github.com/materializecss/materialize
48-
cd materialize
43+
This is the core project with all the components. To see how they are used we recommend using an example project or go to the documentation.
44+
Otherwise, if you want to develop the components itself, the dev process of this core-repo works like this:
45+
```sh
4946
npm install
47+
npm run dev
5048
```
5149

52-
Then run `npm run dev` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000/docs`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation.
50+
### Running documentation locally
51+
See [Materialize Docs Repo](https://github.com/materializecss/materialize-docs) to see Materialize in Action.
5352

5453
### Documentation for previous releases
55-
Previous releases and their documentation are available for [download](https://github.com/materializecss/materialize/releases).
56-
57-
## Build
58-
If you want to build `materialize.css` or `materialize.js` from the latest commit, you can build the files with the following command after `npm install`. See `package.json` to check the current version like `1.0.0`.
54+
Previous releases are available [here](https://github.com/materializecss/materialize/releases).
5955

56+
## Release
57+
If you want to release `materialize.css` or `materialize.js` from the latest commit, you can build the files with the following command after `npm install`. See `package.json` to check the current version like `1.0.0`.
6058
```sh
6159
npm run release -- --oldver=<current_version> --newver=<new_version>
6260
```
@@ -100,4 +98,4 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
10098
[![Backers](https://opencollective.com/materialize/backers.svg?width=890)](https://opencollective.com/materialize#backers)
10199

102100
## Copyright and license
103-
Code Copyright 2023 Materialize. Code released under the MIT license.
101+
Code Copyright 2024 Materialize. Code released under the MIT license.

0 commit comments

Comments
 (0)