From 95fd30239ee8324a0fb23d70cd6ccd2c4e081ad1 Mon Sep 17 00:00:00 2001 From: Simon Petit Date: Thu, 14 Nov 2024 16:23:37 +0100 Subject: [PATCH] WIP readme --- README.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 64c84ff..2e2c772 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # bob -![code size](https://img.shields.io/github/languages/code-size/SiwonP/bob.svg) Bob is a small static generator, for those who wants to maintain a personal website or blog, all from the command line. @@ -10,26 +9,14 @@ It only is designed in bash script, and should work perfectly fine on any Unix like machine. ``` -git clone https://github.com/SiwonP/bob.git +git clone https://git.simonpetit.top cd bob -make install +sudo make install ``` ## Usage -For a start, to generate an empty blog, type in the following in the directory -where you want to put your blog in and follow the guide. - -``` -bob init -``` - -It will create an `index.html` at the root of your folder, a `bases` folder in -which you will store all the posts you want to publish and a `posts` folder -where the resulting posts in html will be stored, and a `drafts` folder where to -put drafts of posts before publishing them. - -To write a post, create a markdown file in the `bases` folder whose name will +To write a post, create a markdown file in the `drafts` folder whose name will also be its title, and convert it to an html file, type the following command from the root :