Skip to content

Commit d925410

Browse files
Refactor README for clarity and consistency in setup instructions
1 parent 968d0c1 commit d925410

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,42 @@
22

33
A personal blogging website created to share my thoughts and experiences on software technologies and open source tools.
44

5-
## Technologies used
5+
## Technologies Used
66

77
1. Static website builder: [Hugo](https://gohugo.io/)
88
2. Theme: [PaperMod](https://themes.gohugo.io/themes/hugo-papermod/)
9+
3. Comments: [Disqus](https://disqus.com/)
10+
4. Diagrams: [Mermaid](https://gohugo.io/content-management/diagrams/#mermaid-diagrams)
11+
5. Dev Containers: [Dev Containers](https://containers.dev)
912

10-
## First time setup
13+
## Setting up the application:
14+
15+
There are two ways to spin up this application
16+
17+
1. The hard way: Install everything in local and hope everything works in CI/CD as well :)
18+
2. The easy way: Using dev containers. Just spin up the application in a docker container.
19+
20+
### Setting up the application: The Hard Way
21+
22+
Make sure you have the following tools installed as pre-requisite. The steps are for mac, but you can use alternatives for your OS.
23+
24+
#### Pre-requisites
25+
26+
1. Install Hugo: `brew install hugo`
27+
2. install pre-commit tool: `pip install pre-commit`
28+
29+
#### Steps
1130

1231
1. Clone the repository
13-
2. Run `pre-commit install -f` to install the `pre-commit` hooks in the repository
14-
3. Install hugo using the command: `brew install hugo`
15-
4. Install the theme submodule using the command: `git submodule update --init --recursive --remote`
16-
5. Install `pre-commit` extension in your text editor to maintain consistency in formatting. To install, run: `brew install pre-commit` and then `pre-commit-install` to update the pre-commit hook in your local repository
32+
2. Install pre-commit in your system by running: `pip install pre-commit`
33+
3. Run `pre-commit install -f` to install the `pre-commit` hooks in the repository
34+
4. Install hugo using the command: `brew install hugo`
35+
5. Install the theme submodule using the command: `git submodule update --init --recursive --remote`
36+
6. Install `pre-commit` extension in your text editor to maintain consistency in formatting. To install, run: `brew install pre-commit` and then `pre-commit-install` to update the pre-commit hook in your local repository
37+
38+
### Setting up the application: The Easy Way
39+
40+
You can use the devcontainers to run a pre-configured developement environment in your machine. This repository already has a prec-configured template in `devcontainer/devcontainer.json`. All you have to do is to run this application on `github codespaces`, `vs code dev containers` or any devcontainer of your choice.
1741

1842
## Create a new content page
1943

0 commit comments

Comments
 (0)