Skip to content

Commit eb41033

Browse files
committed
update README
1 parent ce30e9c commit eb41033

File tree

1 file changed

+7
-35
lines changed

1 file changed

+7
-35
lines changed

README.md

Lines changed: 7 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,13 @@
1-
# Website
1+
# SFU Open Source Development Club Documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
This SFU OS Dev Documentation tool is built using [Docusaurus](https://docusaurus.io/), a modern static website generator and hosted by Github Page.
44

5-
### Installation
5+
[Click here to go to our Documentation](https://sfuosdev.github.io/Docs/)
66

7-
```
8-
$ yarn
9-
```
7+
### purpose of this tool
108

11-
### Local Development
9+
We invite you to contribute to the SFU OS Development Club's Documentation page, designed to support current and future students in Computer Science, Software Systems, Computer Engineering, and Computer Science minors, as well as anyone interested in starting their journey in Computer Science. Our goal is to provide valuable resources that will help individuals excel in group projects and stay ahead in their academic and professional endeavors.
1210

13-
```
14-
$ yarn start
15-
```
11+
To contribute, please submit a Pull Request. Our executive team will review and confirm your submissions before they are published.
1612

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-
21-
```
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.
26-
27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
40-
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.
13+
Thank you for your contributions and continued support!

0 commit comments

Comments
 (0)