From 000891d0f22ceb6c3a068197951b5c900f2b5fff Mon Sep 17 00:00:00 2001 From: waddlaw Date: Fri, 8 Nov 2019 17:24:38 +0900 Subject: [PATCH 1/2] Fix link syntax in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e4046807..f38dd7655 100644 --- a/README.md +++ b/README.md @@ -796,7 +796,7 @@ Other build options are available, using webpack (and purs-loader), or browserif 4. Create your PureScript project with Spago: `spago init`, This also produces a `./src/Main.purs` file which contains some starter code. 5. Initialize the JavaScript/NPM project `npm init` 6. Add WebPack and PureScript-PSA as dependancies `npm install webpack webpack-cli webpack-dev-server purescript-psa --save-dev` -7. Install the PureScript loader and HTML plugin for WebPack `npm install purs-loader html-webpack plugin --save-dev` (Depending on other tools/filetypes you may require additional loaders, This may include css/scss, image files, etc. please refer to the [WebPack documentation][https://webpack.js.org/] for more information) +7. Install the PureScript loader and HTML plugin for WebPack `npm install purs-loader html-webpack plugin --save-dev` (Depending on other tools/filetypes you may require additional loaders, This may include css/scss, image files, etc. please refer to the [WebPack documentation](https://webpack.js.org/) for more information) 8. Create an HTML file that will serve as the entry point for your application. Typically this is `index.html`. in your HTML file, be sure to pull in the `bundle.js` file, which will be Webpack's output. here is an example HTML file: ``` html @@ -932,7 +932,7 @@ console.log('app starting' ) 12. At this point we should be able to test our program by running `npm run webpack:server`, once you navigate in a browser to localhost:4008 you should see '🍝' as output in the javascript development console if this was performed successfully. -13. For production builds, it is recommended to have a seperate build and serve script. Please refer to the [WebPack documentation][https://webpack.js.org/] for more information. Generally production builds use a seperate webpack configuration. +13. For production builds, it is recommended to have a seperate build and serve script. Please refer to the [WebPack documentation](https://webpack.js.org/) for more information. Generally production builds use a seperate webpack configuration. #### Getting Started from Scratch With Nodemon (for Backend and/or CLI projects) @@ -998,7 +998,7 @@ To configure this, add the following script to your `package.json` file: 12. To run a production build, you can simply run `npm run build` and to start a production process, call `npm start` -For publishing CLI programs or NPM modules, please refer to the [npm documentation][https://docs.npmjs.com/cli/publish], however if you are publishing a Node module for consumption by JavaScript users, it is recommended that you pre-compile your purescript project before distributing. +For publishing CLI programs or NPM modules, please refer to the [npm documentation](https://docs.npmjs.com/cli/publish), however if you are publishing a Node module for consumption by JavaScript users, it is recommended that you pre-compile your purescript project before distributing. ### Generate documentation for my project From 1b9222d9eae2a31cd726116cb822303a0e89ac3b Mon Sep 17 00:00:00 2001 From: waddlaw Date: Fri, 8 Nov 2019 17:49:02 +0900 Subject: [PATCH 2/2] Update TOC --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f38dd7655..9d3afcaa2 100644 --- a/README.md +++ b/README.md @@ -132,14 +132,15 @@ $ node . - [Skipping the Build Step](#skipping-the-build-step) - [Make a project with PureScript + JavaScript](#make-a-project-with-purescript--javascript) - [Getting Started from Scratch - With Parcel (Front End Projects)](#getting-started-from-scratch-with-parcel-for-front-end-projects) - - [Getting Started from Scratch - With WebPack (Large Front End Projects)](#getting-started-from-scratch-with-parcel-for-front-end-projects) - - [Getting Started from Scratch - With Nodemon (Back End Projects)](#getting-started-from-scratch-with-parcel-for-front-end-projects) + - [Getting Started from Scratch - With WebPack (Large Front End Projects)](#getting-started-from-scratch-with-webpack-for-front-end-projects) + - [Getting Started from Scratch - With Nodemon (Back End Projects)](#getting-started-from-scratch-with-nodemon-for-backend-andor-cli-projects) - [Generate documentation for my project](#generate-documentation-for-my-project) - [Get source maps for my project](#get-source-maps-for-my-project) - [Publish my library](#publish-my-library) - [Get all the licenses of my dependencies](#get-all-the-licenses-of-my-dependencies) - [Know which `purs` commands are run under the hood](#know-which-purs-commands-are-run-under-the-hood) - [Ignore or update the global cache](#ignore-or-update-the-global-cache) + - [Know the output path for my compiled code](#know-the-output-path-for-my-compiled-code) - [Explanations](#explanations) - [Visual Overview: What happens when you do 'spago build'?](#visual-overview-what-happens-when-you-do-spago-build) - [Configuration file format](#configuration-file-format)