Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 929f27b

Browse files
authored
updated README
1 parent fb07b14 commit 929f27b

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,16 @@ $ git clone <your-github-account> <your-repo-name>
2424
$ cd <your-repo-name>
2525
```
2626

27-
### Bartholomew CLI
27+
### Getting The Bartholomew CLI
28+
29+
Clone and ```make bart``` from [source](https://github.com/fermyon/bartholomew/) (requires Rust), using the following commands (NOTE: ```target/release/bart``` will need to be installed to a user executable directory such as /usr/bin/ to be run when built this way):
30+
31+
```
32+
$ git clone https://github.com/fermyon/bartholomew.git
33+
$ cd bartholomew
34+
$ make bart
35+
```
2836

29-
For the Bart CLI, install all the assets in Bartholomew's official releases just as you have [here](https://github.com/fermyon/bartholomew/releases/tag/v0.6.0).
3037

3138
### ```spin up``` Your Site
3239

@@ -38,9 +45,9 @@ $ spin up --follow-all
3845

3946
When you navigate to ```localhost:3000```, you should see your website running.
4047

41-
### Creating your Content
48+
### Creating your a new item
4249

43-
In this case, you will have to create your pages manually. You will notice we have almost everything ready, you could choose to add more files or delete some. All your contents run directly from the ```content/``` section. Creating your contents starts with creating the files in different directories under the ```content/``` folder. In this case, you’ll see we have ```content/latest```, ```content/kids```, ```content/cart```, etc. You have to create some Markdown files under it to see your contents, and signify the template the Markdown file should work with.
50+
In this case, creating an item is creating a page with the Bartholomew CLI and adding some contents. You will notice we have almost everything ready, you could choose to add more files or delete some. All your contents run directly from the ```content/``` section. Creating your contents starts with creating the files in different directories under the ```content/``` folder. In this case, you’ll see we have ```content/latest```, ```content/kids```, ```content/cart```, etc. You have to create some Markdown files under it to see your contents, and signify the template the Markdown file should work with.
4451

4552
Here’s the structure of a random file in the ```latest/``` directory:
4653

@@ -63,6 +70,18 @@ The first three lines of the code above are essential information for markdown f
6370

6471
The other meta items under the ```[extra]``` section are not the basic ones, they are called the "extra information." The metas’ work with the strings that call them out in the specific template they work with.
6572

73+
- The ```type = post``` meta indicates that this page is a post.
74+
75+
- The ```product_description = "Content"``` meta is for the product's description that you can see in the listing page.
76+
77+
- The ```section = men"``` was added to specify the section of the item, in the case above, the item was fixed to be for a man.
78+
79+
- The ```price = $70``` meta is for the price of the item. The price of the item will be displayed on the listings page.
80+
81+
- The ```tag = "hoodies"``` meta is also to specify what type of item is being sold. In the case above, it's a hoodie.
82+
83+
- The ```photo-src = photopath/photoname.png``` meta is for the photo of the item as this will be displayed on the listings page too.
84+
6685
### Viewing your Site!
6786

6887
With this template, what you could do is modify the contents or add more files and create contents in them. Here’s how you should view your site:
@@ -92,11 +111,11 @@ In this template, adding an item is equivalent to creating a page. Here’s how
92111

93112
To create a latest item — it should be in the file you’re creating has to be in the ```content/latest/``` folder just like this:
94113

95-
```./bart new post content/latest filename.md --template = blog```
114+
```./bart new post content/latest filename.md --template blog```
96115

97116
For creating an item for men, the file you’re creating should be in the ```content/menlisting``` folder just like this:
98117

99-
```./bart new post content/menlisting filename.md --template = blog ```
118+
```./bart new post content/menlisting filename.md --template blog ```
100119

101120
To create an item for kids, the file you are creating has to be in the ‘content/kids’ folder just like this:
102121

@@ -107,7 +126,7 @@ To create an item for kids, the file you are creating has to be in the ‘conten
107126
To create an item for women, the file you are creating has to be in the ```content/womenlisting``` folder just like this:
108127

109128
```
110-
./bart new post content/womenlisting filename.md --template = blog
129+
./bart new post content/womenlisting filename.md --template blog
111130
```
112131

113132
Creating items for the store is just as easy as that, all you have to do is run any of the commands above in your terminal.

0 commit comments

Comments
 (0)