Skip to content

Commit 4e66932

Browse files
committed
Improve README structure: Move development setup to dedicated section
- Reorganize README to have a dedicated 'Development Setup' section - Add information about the npm run dev command - Improve documentation flow and readability
1 parent efc8da5 commit 4e66932

1 file changed

Lines changed: 26 additions & 19 deletions

File tree

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ A modern web interface for browsing and searching your massCode snippets with sy
1919
- [Finding Your massCode Database](#finding-your-masscode-database)
2020
- [Using Docker Compose](#using-docker-compose-recommended)
2121
- [Manual Docker Run](#manual-docker-run)
22+
- [🔧 Development](#development-setup)
2223
- [🤝 Contributing](#-contributing)
2324
- [📄 License](#-license)
2425
- [📈 Star History](#-star-history)
@@ -52,25 +53,6 @@ I love [massCode](https://masscode.io/) - it's an amazing code snippet manager t
5253

5354
## 🚀 Quick Start
5455

55-
### Development Setup
56-
57-
If you want to contribute or modify the styles:
58-
59-
1. **Install dependencies**:
60-
```bash
61-
npm install
62-
```
63-
64-
2. **Build CSS for development** (with file watching):
65-
```bash
66-
npm run build-css
67-
```
68-
69-
3. **Build CSS for production**:
70-
```bash
71-
npm run build-css-prod
72-
```
73-
7456
### Finding Your massCode Database
7557

7658
takeCode works by reading your existing massCode `db.json` file. Here's how to locate it:
@@ -159,6 +141,31 @@ docker run -d -p 8080:80 -v /path/to/your/db.json:/data/db.json:ro ghcr.io/codeb
159141
docker run -d -p 8080:80 -v /path/to/your/db.json:/data/db.json:ro codebude/takecode:latest
160142
```
161143

144+
## 🔧 Development Setup
145+
146+
If you want to contribute or modify the styles:
147+
148+
1. **Install dependencies**:
149+
```bash
150+
npm install
151+
```
152+
153+
2. **Build CSS for development** (with file watching):
154+
```bash
155+
npm run build-css
156+
```
157+
158+
3. **Build CSS for production**:
159+
```bash
160+
npm run build-css-prod
161+
```
162+
163+
4. **Build CSS and run dev server**:
164+
```bash
165+
npm run dev
166+
```
167+
168+
162169
## 🤝 Contributing
163170

164171
Found a bug or have a feature request? Feel free to:

0 commit comments

Comments
 (0)