Skip to content

Commit c112785

Browse files
author
Daniel Botha
committed
Updated: readme file
1 parent 3cf7ca6 commit c112785

1 file changed

Lines changed: 12 additions & 15 deletions

File tree

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ Create generative art by using the canvas api and node js. Before you use the ge
1818

1919
## Installation
2020

21-
If you are cloning the project the run this first, otherwise you can download the source code on the release page and skip this step.
21+
If you are cloning the project then run this first, otherwise you can download the source code on the release page and skip this step.
2222

2323
```sh
2424
git clone https://github.com/HashLips/hashlips_art_engine.git
2525
```
2626

27-
Go to the root of you folder and run this command if you have yarn installed.
27+
Go to the root of your folder and run this command if you have yarn installed.
2828

2929
```sh
3030
yarn add all
3131
```
3232

33-
Alternativly you can run this command if you have node installed.
33+
Alternatively you can run this command if you have node installed.
3434

3535
```sh
3636
npm install
@@ -61,14 +61,14 @@ const layerConfigurations = [
6161

6262
The `name` of each layer object represents the name of the folder (in `/layers/`) that the images reside in.
6363

64-
Optionally you can now add multiple different `layerConfigurations` to you collection. Each confugiration can be uinque and have different layer order, use the same layers or intruduce new onces. This gives the artist flexibility when it comes to fine tuning their collections to their needs.
64+
Optionally you can now add multiple different `layerConfigurations` to your collection. Each configuration can be unique and have different layer orders, use the same layers or introduce new ones. This gives the artist flexibility when it comes to fine tuning their collections to their needs.
6565

66-
_Example:_ If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear and you want to create a new race or just simple re-order the layers or even introduce new layers, so your `layerConfigurations` and `layersOrder` would look something like this:
66+
_Example:_ If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear and you want to create a new race or just simple re-order the layers or even introduce new layers, then you're `layerConfigurations` and `layersOrder` would look something like this:
6767

68-
`````js
68+
```js
6969
const layerConfigurations = [
7070
{
71-
// Creates upto 50 artworks
71+
// Creates up to 50 artworks
7272
growEditionSizeTo: 50,
7373
layersOrder: [
7474
{ name: "Background" },
@@ -80,7 +80,7 @@ const layerConfigurations = [
8080
],
8181
},
8282
{
83-
// Creates an aditional 100 artworks
83+
// Creates an additional 100 artworks
8484
growEditionSizeTo: 150,
8585
layersOrder: [
8686
{ name: "Background" },
@@ -109,13 +109,13 @@ or
109109
node index.js
110110
```
111111

112-
The program will output all the images in the `build` directory along with the metadata files. Each collection will have a `_metadata.json` file that consists of all the metadata in the collection inside the `build` folder. The `build` folder also will contain alll the images as well as single json files that represents each image file. The single json file of a image will look somthing like this:
112+
The program will output all the images in the `build` directory along with the metadata files. Each collection will have a `_metadata.json` file that consists of all the metadata in the collection inside the `build` folder. The `build` folder also will contain all the images as well as single json files that represent each image file. The single json file of a image will look something like this:
113113

114-
````json
114+
```json
115115
{
116116
"dna": "d956cdf4e460508b5ff90c21974124f68d6edc34",
117117
"name": "#1",
118-
"description": "This is the description of your NFT project, remember to replace this",
118+
"description": "This is the description of your NFT project",
119119
"image": "https://hashlips/nft/1.png",
120120
"edition": 1,
121121
"date": 1631690799975,
@@ -132,7 +132,4 @@ The program will output all the images in the `build` directory along with the m
132132
}
133133
```
134134

135-
Thats it, your done. Hope you create some awesome artworks with this code.
136-
137-
138-
`````
135+
That's it, you're done. Hope you create some awesome artworks with this code.

0 commit comments

Comments
 (0)