Skip to content

Commit f2b18db

Browse files
committed
Fix typos and improve clarity in documentation; update placeholder content in output files
1 parent c66e89e commit f2b18db

File tree

4 files changed

+42
-36
lines changed

4 files changed

+42
-36
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ for publishing things that matter — without starting a startup.
66
*Minimum code, maximum outcomes.*
77
*WHAM! BAM! And you have a static page man!*
88

9-
GAMstack is the natural and inevitable spritual successor to legacy software stacks such as:
9+
GAMstack is the natural and inevitable spiritual successor to legacy software stacks such as:
1010

1111
- **JAMstack** (JavaScript, APIs, and Markup) – because JavaScript is bloated and Markdown was doing just fine.
1212
- **MACH** (Microservices, API-first, Cloud-native, and Headless) – because microservices are just meetings in disguise.
@@ -79,14 +79,13 @@ Ideal for:
7979

8080
## 🔄 How It Works
8181

82-
1. **Content Management**:
83-
- Store content in `posts/` as Markdown files (`.md`)
84-
- Each file = one post
82+
1. **Content Management System**:
83+
- Store content in `input/` as Markdown files (`.md`)
84+
- Each file = one post
8585

8686
2. **GitHub Actions**:
87-
- Workflow watches for changes in `posts/`
88-
- Runs `update-index.js` to regenerate `index.html`
89-
- Converts `.md` to `.html` and stores in `output/`
87+
- Workflow blindly converts all `.md` items in folder `input/` to `.html` and outputs into `output/`
88+
- GitHub Action regenerates `index.html` with a list of `.html` files
9089

9190
3. **GitHub Pages**:
9291
- Hosts everything statically
@@ -95,39 +94,46 @@ Ideal for:
9594

9695
---
9796

98-
## ✍️ Getting Started
97+
## ✍️ Start your blog, website, or another compulsive ADHD adventure
9998

100-
1. **Clone the repo**:
101-
```bash
102-
git clone https://github.com/your-repo/gam-stack.git
103-
cd gam-stack
104-
```
99+
1. **Clone this repo**:
105100

106-
2. **Add a new post**:
107-
```markdown
108-
# My New Post
109-
110-
Markdown is cool.
111-
```
101+
2. **Add a `.md` file to `/input/` folder**:
112102

113103
3. **Commit & Push**:
114-
```bash
115-
git add .
116-
git commit -m "Add new post"
117-
git push
118-
```
119104

120-
4. **Profit**:
105+
4. **HTML page will appear in `/output/` and `index.html` will be regenerated with a list of all pages**
106+
107+
5. **Profit**:
121108
- Open your GitHub Pages URL
122109
- Bask in the glow of functional minimalism
123110

124111
---
125112

113+
## 🌐 Setting Up GitHub Pages
114+
115+
1. **Enable your GitHub Pages**:
116+
- Clone GAMstack repository https://github.com/roktiw/gamstack
117+
- Go to your cloned GAMstack repository on GitHub portal.
118+
- Go to repository `Settings`
119+
- Rename your `Repository name` to `YOUR_GITHUB_USERNAME.github.io`
120+
- Click "Rename" button.
121+
122+
If sth not works, check out official GitHub Pages documentation https://docs.github.com/en/pages/quickstart
123+
124+
2. **Verify Deployment**:
125+
- After a few moments, your site will be live at `https://OUR_GITHUB_USERNAME.github.io/`.
126+
127+
3. **Write a new note every day**
128+
- Writing helps your brain to rewire and makes you live longer
129+
130+
---
131+
126132
## 🙌 Contributing
127133

128134
PRs welcome. But only if they make things simpler.
129135

130136
---
131137

132-
© Wiktor Świtkowski 2025 – [GAMstack™](https://github.com/wiktor-switkowski)
133-
Built with love, Markdown and passive aggression toward bloated tooling.
138+
© Wiktor Świątkowski 2025 – [GAMstack™](https://github.com/wiktor-switkowski)
139+
Built with love, in Warsaw, using Markdown and passive aggression toward bloated tooling.

input/how-to-input.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# How to input for GAMstack
22

3-
Just write a Markdown note.
3+
Just write a Markdown note. Seriously, that's it. No YAML, no JSON, no "microservice orchestration pipeline." Just Markdown. It's like writing a love letter to simplicity.
44

5-
You can use vscode, or directly create file on GitHub. Anything goes as long as the .md file goes into this beautiful `/input/` folder.
5+
You can use VS Code, or directly create a file on GitHub. Heck, you could even use Notepad if you're feeling nostalgic. Anything goes as long as the `.md` file lands in this sacred `/input/` folder.
66

7-
Yes. Its that simple.
7+
Yes. It's that simple. No, really. Stop overthinking it.
88

9-
## How I will know that magic works?
9+
## How will I know that the magic works?
1010

11-
You will see this file in `/output/` folder
11+
You will see this file in the `/output/` folder. Yes, you. Reading this file. Twice. First as a humble `.md` file, and then as a glorious `.html` file. It's like watching your code grow up and graduate.
1212

13-
## See you on the HTML side!
13+
## See you on the HTML side!
14+
15+
(And don't forget to wave at your Markdown file on the way out. It worked hard to get here.)
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
# Yes
2-
3-
It is that simple!
1+
this markdown file is just a placeholder, like a movie extra waiting for its big break. Feel free to kick it out when the real star arrives!

0 commit comments

Comments
 (0)