Skip to content

Commit 1f5811f

Browse files
authored
feat: Updated README (#8)
1 parent 4bbca07 commit 1f5811f

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1-
# UMLCloudComputing.github.io
1+
<div align="center">
2+
<a href="https://cloudcomputingclub.cs.uml.edu/">
3+
<img src="./club-logo.png" alt="Logo" width="50%" height="50%">
4+
</a>
5+
<hr>
6+
<h1>The UML Cloud Computing Club Website</h1>
7+
</div>
28

3-
testing
9+
10+
This is the official repo for the UML Cloud Computing Club's website.
11+
12+
The website is implemented using [Docusaurus](https://docusaurus.io/) and some fundamental [ReactJS](https://react.dev/).
13+
14+
15+
## 👨‍💻 Documentation and Tutorials Contribution Guidelines
16+
17+
To edit the documentation sections or the tutorials section of the website:
18+
19+
1. Create a new branch from the **main** branch
20+
2. Make the appropriate edits within this branch
21+
3. Make an eventual pull request for the branch to be merged into **main**
22+
4. Await approval or make the reviewers' requested changes and resubmit
23+
24+
25+
All markdown files containing documentation details of the projects are in **docs/projects/** with the project's name marking the folder that contain's it's documentation
26+
27+
All markdown files containing tutorial details are in **docs/tutorials/** with the specific tutorial's name makring the folder that contain's it's files.
28+
29+
All markdown files should follow Docusaurus's guidelines for folder structure for autogenerating the UI and pagination. More details are available at the [Docusaurus Docs](https://docusaurus.io/docs/sidebar/autogenerated).
30+
31+
## 🎉Acknowledgements
32+
[![Contributors](https://contributors-img.web.app/image?repo=UMLCloudComputing/UMLCloudComputing.github.io)](https://github.com/UMLCloudComputing/UMLCloudComputing.github.io/graphs/contributors)
33+
34+
### Happy Coding!

club-logo.png

1.24 MB
Loading

0 commit comments

Comments
 (0)