| 1 |
|
| 2 | <p align="center">
|
| 3 | <a href="https://millwrightjs.com">
|
| 4 | <img
|
| 5 | width="300px"
|
| 6 | src="https://raw.githubusercontent.com/millwrightjs/millwright/master/logo.png">
|
| 7 | </a>
|
| 8 | </p>
|
| 9 | <p align="center">
|
| 10 | <strong>The easiest build tool you'll ever use.</strong>
|
| 11 | </p>
|
| 12 | <hr>
|
| 13 | <p align="center">
|
| 14 | <a href="https://travis-ci.org/millwrightjs/millwright"><img
|
| 15 | src="https://travis-ci.org/millwrightjs/millwright.svg?branch=master"
|
| 16 | alt="Build Status"></a>
|
| 17 | <a href="https://gitter.im/millwrightjs/millwright"><img
|
| 18 | src="https://badges.gitter.im/join%20chat.svg" alt="Join Gitter Chat"></a>
|
| 19 | </p>
|
| 20 | <hr>
|
| 21 |
|
| 22 | ## Give us a star!
|
| 23 | Millwright is brand spanking new - the alpha release was announced at the beginning of the year. If
|
| 24 | you like where the project is headed, star us on GitHub and help spread the word!
|
| 25 |
|
| 26 | ## Get help on Gitter!
|
| 27 | Join the chat on [Gitter](https://gitter.im/millwrightjs/millwright) to get (or give) realtime help
|
| 28 | from the community.
|
| 29 |
|
| 30 | <hr>
|
| 31 |
|
| 32 | ## Intro
|
| 33 | Millwright provides the common build functionality that many web projects need without any tool
|
| 34 | configuration.
|
| 35 |
|
| 36 | Please visit [millwrightjs.com](https://millwrightjs.com) for more information, including usage and
|
| 37 | installation.
|
| 38 |
|
| 39 | ## Project status
|
| 40 | Millwright is currently in Alpha. That means that the basic feature set expected for the 1.0.0
|
| 41 | milestone is in place, and that it's generally expected to work as described. Alpha status also
|
| 42 | means that the library is highly untested, and that the project is ready for developer usage and
|
| 43 | contributions via issues and PR's.
|
| 44 |
|
| 45 | Current priorites include:
|
| 46 |
|
| 47 | * Windows support (look for that Appveyor badge soon)
|
| 48 | * Refactoring
|
| 49 | * Error messaging
|
| 50 | * Input validation
|
| 51 | * Testing, testing, and more testing
|
| 52 |
|
| 53 | ## Issues
|
| 54 | We'll take any and all issue reports, we just ask that any helpful info be provided, such as
|
| 55 | environment details and any stack traces or error messages.
|
| 56 |
|
| 57 | ## Pull Requests
|
| 58 | This project does not yet have a formal styleguide. For now, the following considerations should be
|
| 59 | observed when submitting code:
|
| 60 |
|
| 61 | * Communicate via issues and get confirmation before doing anything big
|
| 62 | * Style matters - keep it clean
|
| 63 | * Add or update relevant tests (currently happening in [e2e](https://github.com/millwrightjs/millwright/tree/master/e2e)).
|
| 64 |
|
| 65 | ## Building Locally
|
| 66 | The following commands are available for building Millwright locally:
|
| 67 |
|
| 68 | * `npm run build` - runs the build
|
| 69 | * `npm run watch` - runs the build, then watches for changes |
| \ | No newline at end of file |