Skip to content

Commit 36f761f

Browse files
committed
doc: readme was updated
1 parent 79439db commit 36f761f

File tree

1 file changed

+60
-19
lines changed

1 file changed

+60
-19
lines changed

README.md

Lines changed: 60 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,82 @@
1-
# Website
21

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
2+
# Grupo Scout #44 Website
3+
4+
This is the official website for Grupo Scout #44, built using [Docusaurus](https://docusaurus.io/), a modern static website generator optimized for documentation and educational content.
5+
6+
![Scout Logo](/static/img/logo-gs44.png)
7+
8+
## 🚀 Getting Started
9+
10+
### Prerequisites
11+
12+
- [Node.js](https://nodejs.org/) (v16 or higher)
13+
- [Yarn](https://yarnpkg.com/) package manager
414

515
### Installation
616

7-
```
8-
$ yarn
17+
Clone the repository and install dependencies:
18+
19+
```bash
20+
git clone https://github.com/Lenugo/scout-44.git
21+
cd scout-44
22+
yarn
923
```
1024

1125
### Local Development
1226

13-
```
14-
$ yarn start
27+
Start the local development server:
28+
29+
```bash
30+
yarn start
1531
```
1632

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
33+
This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
1834

19-
### Build
35+
## 🛠️ Project Structure
2036

21-
```
22-
$ yarn build
23-
```
37+
- `/docs/` - Documentation content organized by scout units
38+
- `/src/pages/` - React pages for the website
39+
- `/static/` - Static files like images and PDFs
40+
- `/blog/` - Blog posts (if used)
41+
- `utils/` - Utility functions and scripts
2442

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
43+
## 📝 Content Management
2644

27-
### Deployment
45+
- Add new manuals to `/static/files/`
46+
- Update calendar events in `/src/pages/calendario.mdx`
47+
- Modify unit information in the corresponding docs folders
2848

29-
Using SSH:
49+
## 🏗️ Build and Deployment
3050

51+
### Build
52+
53+
```bash
54+
yarn build
3155
```
32-
$ USE_SSH=true yarn deploy
33-
```
3456

35-
Not using SSH:
57+
This command generates static content into the `build` directory that can be served by any static hosting service.
58+
59+
### Deployment to GitHub Pages
3660

61+
```bash
62+
GIT_USER=<Your GitHub username> yarn deploy
3763
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
64+
65+
This builds the website and pushes to the `gh-pages` branch.
66+
67+
## 🤝 Contributing
68+
69+
Contributions are welcome! Please feel free to submit a Pull Request.
70+
71+
## 📄 License
72+
73+
This project is licensed under the MIT License - see the LICENSE file for details.
3974
```
4075
41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
76+
This README provides:
77+
- Clear project identification and purpose
78+
- Visual element with the Scout logo
79+
- Better organized sections with emojis for quick scanning
80+
- More detailed project structure information
81+
- Content management guidance specific to your Scout website
82+
- Improved formatting and readability

0 commit comments

Comments
 (0)