chore: Update license and README files

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Haodong Tian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,4 +1,77 @@
-# esg-seu-website
-The website of Edge System Group @ SEU
+# SEU Edge System Group Website
 
-The code of this website is from https://wands.sg/team/groupMeeting/index.html.
+This repository contains the source code for the official website of the Edge System Group at Southeast University (SEU).
+
+The main purpose of this website is to host the presentation schedules for the reading group of the Edge System Group at SEU. The website is built using Node.js and EJS templating engine, with a custom build process for generating static pages.
+
+## Prerequisites
+
+Before you begin, ensure you have met the following requirements:
+
+- You have installed Node.js (version 12.x or later recommended)
+- You have a basic understanding of JavaScript and Node.js
+
+## Getting Started
+
+To install the project, follow these steps:
+
+```bash
+git clone https://github.com/SEU-ESG/seu-esg.github.io.git
+cd seu-esg.github.io
+npm install
+```
+
+To use SEU-ESG website, follow these steps:
+
+### Building the website
+
+```bash
+npm run build
+```
+
+This command will generate static HTML files in the `dist` directory, which can be deployed to a web server.
+
+### Start the development server
+
+To run the website in development mode with a local server:
+
+```bash
+npm run dev
+```
+
+Note that this command starts a dev server after running the build process. It will serve the files from the `dist` directory at `http://localhost:3000` (check the console output for the exact URL).
+
+### Updating Schedules
+
+To add a new schedule for the reading group:
+
+1. Open the file `configs/schedules.yaml`
+2. Edit this file to add or modify schedules
+3. Save the file and rebuild the website using `npm run build`
+
+### Adding Presentation Slides
+
+To add presentation slides:
+
+1. Place the slide files in the `slides` directory
+2. Reference these slides in your schedule entries in `configs/schedules.yaml`
+
+### Updating Blogs
+
+To add a new blog post:
+
+1. Create a new markdown file in the `blogs` directory
+2. Add the necessary metadata to the file
+3. Rebuild the website using `npm run build`
+
+### Advanced Configuration
+
+For advanced configurations, refer to `configs/global.yaml`. This file contains global settings for the website.
+
+## Contact
+
+If you want to contact the maintainer of this project, please reach out to @liu-mengyang.
+
+## License
+
+This project is licensed under the MIT License.

scripts/build.js

@@ -31,6 +31,9 @@ function render(md) {
 const global = yaml.load(fs.readFileSync('configs/global.yaml'), 'utf8');
 const schedules = yaml.load(fs.readFileSync('configs/schedules.yaml'), 'utf8');
 
+// Render global.footer, remove the outer <p> tag
+global.footer = render(global.footer).replace(/^<p>|<\/p>$/g, '');
+
 // Read the blog posts from /blog, sort by date
 const blogs = fs.readdirSync('blog')
   .map(file => {

views/blog.ejs

@@ -158,7 +158,7 @@
         <div class="ui vertical segment">
             <div class="ui center aligned container">
                 <div class="ui horizontal small divided link list">
-                    <%= global.footer %>
+                    <%- global.footer %>
                 </div>
             </div>
         </div>

views/index.ejs

@@ -162,7 +162,7 @@
         <div class="ui vertical segment">
             <div class="ui center aligned container">
                 <div class="ui horizontal small divided link list">
-                    <%= global.footer %>
+                    <%- global.footer %>
                 </div>
             </div>
         </div>