Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README instructions and add script to run locally #19

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README instructions and add script to run locally #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,22 @@ Open to additions and pull requests.

## Installation

### Install Node.js and Jekyll
### Install Node and Ruby dependencies

Before using avatar-framer, you must ensure that Node.js and Jekyll are installed on your system. To install, do the following:
Before using avatar-framer, you must install its dependencies by doing the
following:

1. Install [Node.js](https://nodejs.org) and npm.
<!-- Node.js and NPM may be installed together; link goes to a Google search for
the latest instructions. -->
1. Install [Node.js and NPM](https://www.google.com/search?q=installing+NPM).

2. Install [Jekyll](https://jekyllrb.com/docs/installation)
2. Install [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/).

3. Install dependancies:

```
npm install
bundle install
```

### Usage - Generate your site
Expand All @@ -39,6 +44,8 @@ jekyll build
npm run build
```

5. Preview the site using `npm run serve` and going to http://localhost:8080

### Image requirements
#### Frames
* Frames should be `2000px x 2000px` for maximum resolution.
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
"build": "bundle exec jekyll build && npm run js && npm run css && npm run prod-css && npm run min",
"build-docs": "npm run build && rsync -av * docs/ --exclude docs --exclude index.html --exclude _config.yml --exclude README.md",
"watch:css": "postcss src/css/styles.css -o dist/css/styles.css --watch",
"dev": "concurrently --kill-others-on-fail --names \"JS,JEKYLL,CSS\" --prefix-colors \"bgBlue.bold,bgGreen.bold,bgMagenta.bold\" \"npm run js\" \"sleep 5 && bundle exec jekyll serve --livereload --livereload-min-delay 2\" \"npm run watch:css\""
"dev": "concurrently --kill-others-on-fail --names \"JS,JEKYLL,CSS\" --prefix-colors \"bgBlue.bold,bgGreen.bold,bgMagenta.bold\" \"npm run js\" \"sleep 5 && bundle exec jekyll serve --livereload --livereload-min-delay 2\" \"npm run watch:css\"",
"serve": "cd _site && http-server -c-1"
},
"keywords": [],
"author": "Andrew Quinn",
Expand Down