Skip to content

Commit 0f9f00a

Browse files
committed
update readme
1 parent fd44c01 commit 0f9f00a

File tree

1 file changed

+21
-28
lines changed

1 file changed

+21
-28
lines changed

README.md

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,34 @@
1-
# Website
1+
# CLSFramework Website
2+
This is the repository for the CLSFramework website. The website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
23

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
### Installation
5+
## Run the website locally
66

7+
1. Clone the repository
8+
2. Install the dependencies
9+
```bash
10+
npm install
711
```
8-
$ yarn
12+
3. Run the development server
13+
```bash
14+
npm start
915
```
16+
4. Open [http://localhost:3000](http://localhost:3000) in your browser.
1017

11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
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.
18-
19-
### Build
20-
18+
## Build the website
19+
1. Run the build command
20+
```bash
21+
npm run build
2122
```
22-
$ yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
23+
2. The build files will be in the `build` directory.
2624

27-
### Deployment
25+
## How to contribute
26+
1. Fork the repository
27+
2. Create a new branch
28+
3. Make your changes
29+
4. Create a pull request
2830

29-
Using SSH:
3031

31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
3432

35-
Not using SSH:
3633

37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
4034

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.

0 commit comments

Comments
 (0)