removes npm and gulp to stop scaring github
This commit is contained in:
parent
5eaaa6b095
commit
96b49dc9b7
35
README.md
35
README.md
|
@ -5,10 +5,6 @@ Welcome to the Zcash Foundation Website. This repository does **two things**:
|
|||
1. Holds documents for the foundation.
|
||||
2. Holds the source code for the website.
|
||||
|
||||
**Workshop Notes from Zcon1**
|
||||
|
||||
If you are submitting notes for workshops at Zcon1, please add them to [this folder](https://github.com/ZcashFoundation/zfnd/tree/master/zcon/1/workshop-notes).
|
||||
|
||||
## Foundation Documents
|
||||
|
||||
Here are the main documents in this repo. For all of them, to see the same, rendered versions, go to [the website](https://zfnd.org).
|
||||
|
@ -28,36 +24,7 @@ The rest of the files are websites.
|
|||
|
||||
## Adding Images
|
||||
|
||||
The folder `images/src` is for the images you get pretty much anywhere - all of the images that you haven't yet optimized for the web. Put them in there, and then run:
|
||||
|
||||
```sh
|
||||
# In the main directory
|
||||
$ gulp
|
||||
```
|
||||
|
||||
...which will go around shrinking them. As an example, it took the `zeal-zcash-foundation-feature-image.jpg` and shrunk it down to a fourth of the size that it was before.
|
||||
|
||||
If you don't have Gulp installed, you can get it by doing this:
|
||||
|
||||
```sh
|
||||
$ npm install --global gulp
|
||||
# And, in this directory...
|
||||
$ npm install
|
||||
```
|
||||
|
||||
Never embed images in `images/src` in a blogpost; they should always be copied over to `images` automatically by Gulp, and that will ensure that you're serving up nice issues to your users. The way to embed them is using this syntax:
|
||||
|
||||
```markdown
|
||||
Look at our zealous zebras!
|
||||
|
||||
![Zealous zebras](images/zeal-zcash-foundation-feature-image.jpg)
|
||||
```
|
||||
|
||||
Note that the path is relative to where the Markdown file is. This will look pretty much like this:
|
||||
|
||||
![Zealous zebras](images/zeal-zcash-foundation-feature-image.jpg)
|
||||
|
||||
You _can_ add images directly to images without running Gulp, but they just won't be as small as your users might like. But that's always an option as needed.
|
||||
The folder `images/src` is for the images you get pretty much anywhere.
|
||||
|
||||
## Contribute
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load Diff
18
package.json
18
package.json
|
@ -1,18 +0,0 @@
|
|||
{
|
||||
"name": "zcashfoundation.github.io",
|
||||
"private": true,
|
||||
"version": "0.0.0",
|
||||
"main": "gulpfile.js",
|
||||
"devDependencies": {
|
||||
"gulp": "^3.9.1",
|
||||
"gulp-changed": "^3.2.0",
|
||||
"gulp-image-resize": "^0.13.0",
|
||||
"gulp-imagemin": "^4.1.0",
|
||||
"imagemin-pngcrush": "^5.1.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"gulp-concat": "^2.6.1",
|
||||
"gulp-rename": "^1.4.0",
|
||||
"gulp-uglify": "^3.0.1"
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue