From 6d2e11fe8e70783d705509832fa63a3e98ccbb21 Mon Sep 17 00:00:00 2001 From: Jack Reed <phillipjreed@gmail.com> Date: Wed, 1 Mar 2017 13:40:04 -0500 Subject: [PATCH] Updates docs to remove bower install From the installation instructions, it appears that bower install is needed. This isn't true and we are moving away from bower, so updating docs accordingly. Closes #954 --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3d46eef4..497f5b518 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Mirador uses [node.js](http://nodejs.org/) and a build system to assemble, test, 2. Install the Grunt command line runner (if you haven't already); on the command line, run `npm install -g grunt-cli` 3. Clone the mirador repository (if you haven't already done so above); `git clone https://github.com/ProjectMirador/mirador.git` 4. On the command line, go into the mirador folder - 5. Install all dependencies with `npm install` and `bower install`. Run `npm start` + 5. Install all dependencies with `npm install`. Run `npm start` `npm start` will run a local server that is available at `localhost:8000`. @@ -21,7 +21,7 @@ Even small changes should follow the branching strategy outlined above, though t Mirador currently uses [gitbook](https://github.com/GitbookIO/gitbook) for its documentation. You can find the current documentation in the `docs` folder on any branch. The docs will be re-generated for the website when submitted, and kept up to date with the current master. Documentation updates are always welcome, and should be included with any fundamentally new changes. For general documentation submission, checkout the master branch and branch from it into a documentation branch. Add to the gitbook files stored in the `docs` directory. ### Updating and Running the Project -Install all dependencies with `npm install` and `bower install`. Run `npm start`. This ensures that any new changes from the remote are picked up in your development build. +Install all dependencies with `npm install`. Run `npm start`. This ensures that any new changes from the remote are picked up in your development build. Create a branch for your work: e.g.: `git checkout -b my-feature-branch` or `git checkout -b my-bug-fix` @@ -78,7 +78,7 @@ Mirador uses the node.js runtime for its development environment, and to bundle #### The NPM package manager Dependencies are managed primarily with the NPM package manager, and releases are primarily distributed over npm. It is recommended that any new dependencies being added are tracked with a specific version in the `package.json` and installed with npm. The final build dependency is then copied into the `js/lib` directory for inclusion into Mirador. Only this copied final version of the dependency should be versioned (added to git). #### Javascript Resources -#### Bower Package Manager +#### Bower Package Manager [DEPRECATED] Some resources are managed with bower, but this is being phased out. It is recommended that no new dependency be added through bower unless it is truly unavailable on NPM. ### Project Management with Grunt [Grunt](http://gruntjs.com/) is a utility for managing repetitive tasks involved in the development process, such as building, linting, format-checking, and compressing files, running tests and generating coverage reports, and reloading the browser on file changes (for interactive feedback during feature development). A variety of tasks have been automated for developer convenience. diff --git a/README.md b/README.md index bab9d7a9c..6e97a2cce 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Mirador uses [node.js](http://nodejs.org/) and a build system to assemble, test, 2. Install the Grunt command line runner (if you haven't already); on the command line, run `npm install -g grunt-cli` 3. Clone the mirador repository (if you haven't already done so above) 4. On the command line, go into the mirador folder - 5. Install all dependencies with `npm install` and `bower install`. Run `npm start'. + 5. Install all dependencies with `npm install`. Run `npm start'. ### Run Tests `npm test` -- GitLab