From bc6a9ed05eb1b9d5ce0f7ab33a448ce36b10dd63 Mon Sep 17 00:00:00 2001 From: Allynixtor <97223164+Allynixtor@users.noreply.github.com> Date: Wed, 15 Nov 2023 20:45:59 +1100 Subject: [PATCH] Update README.md (#259) --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3400913..08d1c6a 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,9 @@ A place for the CSESoc community to learn and share their knowledge and expertis 1. Clone this repo -2. `npm install` to install all dependencies -3. `npm run dev` to start the local server +2. `yarn install` to install all dependencies +3. `yarn build` to generate an optimised version of the application for production +4. `yarn start` to start the local server ## Vision ⚡️ @@ -61,6 +62,9 @@ See the [wiki](https://github.com/csesoc/learning-platform/wiki). We're CSESoc Education! Development is currently led by: +- [Max Xue](https://github.com/M-Xue) +- [Liam Smith](https://github.com/BinaryGamer) +- [Simon Nguyen](https://github.com/Allynixtor) - [Maxwell Phillips](https://github.com/maxphillipsdev) - [Jeffrey Yao](https://github.com/jeffreydyao) - [Gordon Huang](https://github.com/dqna64) @@ -71,21 +75,21 @@ We're CSESoc Education! Development is currently led by: The Learning Platform has a standard format for publishing course revision materials. It assumes that a course revision campaign consists of a set of exercises that can be written in markdown. -In this *course-revision* folder observe that there are folders likes *1511-22T3* with mdx files inside. There is also a corresponding *1511-22T3.mdx* file next to the folder of the same name. +In this *course-revision* folder observe that there are folders likes *1511-23T3* with mdx files inside. There is also a corresponding *1511-23T3.mdx* file next to the folder of the same name. When you create a new course revision campaign, you **must** provide the following: -- An mdx file *course-revision/.mdx* which contains some info about this course revision campaign and how to get set up for the exercises (e.g. downloading some starter code). The should be replaced with the name of the course offering that this revision session is made for e.g. *1511-22T3* The fields you must provide in the yaml are: +- An mdx file *course-revision/.mdx* which contains some info about this course revision campaign and how to get set up for the exercises (e.g. downloading some starter code). The should be replaced with the name of the course offering that this revision session is made for e.g. *1511-23T3* The fields you must provide in the yaml are: - title: Title of the course revision campaign (e.g. CSESoc COMP1511 Revision Practice Problems) - - desc: Brief descriptoin of this course revision campaign (e.g. Practical coding exercises to help you prepare for your COMP1511 22T3 final exam) + - desc: Brief descriptoin of this course revision campaign (e.g. Practical coding exercises to help you prepare for your COMP1511 23T3 final exam) - course: (e.g. COMP1511) (Currently not used in the code) - - offering: (e.g. 22T3) (Currently not used in the code) + - offering: (e.g. 23T3) (Currently not used in the code) - A folder *course-revision/* which contains mdx files for each exercise. The fields you must provide in the yaml are: - title: Title of the exercise (e.g. BST Difference) - desc: Brief description of exercise (e.g. Find the mininum distance between any two numbers in a binary search tree) - class: Which course this exercise is for (eg. COMP2521) - difficulty: Difficult rating (1=easy, 2=medium, 3=hard) (e.g. 2) -Note: Both the .mdx and folder **MUST** share the exact same name in order to work (e.g. file `1511-22T3.mdx` and folder `1511-22T3`) +Note: Both the .mdx and folder **MUST** share the exact same name in order to work (e.g. file `1511-23T3.mdx` and folder `1511-23T3`) -Once you have uploaded these files you can navigate to them at the url */course-revision* (e.g. *learn.csesoc.org.au/course-revision* or *localhost:3000/course-revision*) \ No newline at end of file +Once you have uploaded these files you can navigate to them at the url */course-revision* (e.g. *learn.csesoc.org.au/course-revision* or *localhost:3000/course-revision*)