Skip to content

Commit f162e59

Browse files
committed
added README.md
1 parent 2611ca8 commit f162e59

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Blog
2+
3+
This is a [Hugo blog](https://shelltux.github.io/blog/) project where I share my
4+
thoughts and musings on various topics.
5+
6+
## Installation
7+
8+
1. Clone the repository
9+
10+
```sh
11+
git clone https://github.com/ShellTux/blog.git
12+
git submodule update --init --recursive
13+
```
14+
15+
2. Install Hugo
16+
17+
Follow the instructions on the [Hugo
18+
website](https://gohugo.io/getting-started/installing/) to install Hugo on your
19+
machine.
20+
21+
3. Run the blog locally
22+
23+
```sh
24+
make serve
25+
```
26+
27+
4. View the blog in your browser at `http://localhost:1313/blog`
28+
29+
## Usage
30+
31+
1. Write a new blog post by creating a new Markdown file in the `content/posts` directory.
32+
33+
2. Customize the blog's appearance by modifying the theme settings in the `hugo.yaml` file.
34+
35+
3. Deploy the blog by running `hugo` and then copying the generated `public` directory to your web server.
36+
37+
## Contributing
38+
39+
If you would like to contribute to this project, please fork the repository and
40+
submit a pull request.

0 commit comments

Comments
 (0)