Skip to content

Commit bc6a9ed

Browse files
authored
Update README.md (#259)
1 parent 06b5b8f commit bc6a9ed

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ A place for the CSESoc community to learn and share their knowledge and expertis
2323
2424

2525
1. Clone this repo
26-
2. `npm install` to install all dependencies
27-
3. `npm run dev` to start the local server
26+
2. `yarn install` to install all dependencies
27+
3. `yarn build` to generate an optimised version of the application for production
28+
4. `yarn start` to start the local server
2829

2930
## Vision ⚡️
3031

@@ -61,6 +62,9 @@ See the [wiki](https://github.com/csesoc/learning-platform/wiki).
6162

6263
We're CSESoc Education! Development is currently led by:
6364

65+
- [Max Xue](https://github.com/M-Xue)
66+
- [Liam Smith](https://github.com/BinaryGamer)
67+
- [Simon Nguyen](https://github.com/Allynixtor)
6468
- [Maxwell Phillips](https://github.com/maxphillipsdev)
6569
- [Jeffrey Yao](https://github.com/jeffreydyao)
6670
- [Gordon Huang](https://github.com/dqna64)
@@ -71,21 +75,21 @@ We're CSESoc Education! Development is currently led by:
7175
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.
7276

7377

74-
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.
78+
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.
7579

7680
When you create a new course revision campaign, you **must** provide the following:
7781

78-
- An mdx file *course-revision/<course-offering>.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 <course-offering> 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:
82+
- An mdx file *course-revision/<course-offering>.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 <course-offering> 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:
7983
- title: Title of the course revision campaign (e.g. CSESoc COMP1511 Revision Practice Problems)
80-
- desc: Brief descriptoin of this course revision campaign (e.g. Practical coding exercises to help you prepare for your COMP1511 22T3 final exam)
84+
- desc: Brief descriptoin of this course revision campaign (e.g. Practical coding exercises to help you prepare for your COMP1511 23T3 final exam)
8185
- course: (e.g. COMP1511) (Currently not used in the code)
82-
- offering: (e.g. 22T3) (Currently not used in the code)
86+
- offering: (e.g. 23T3) (Currently not used in the code)
8387
- A folder *course-revision/<course-offering>* which contains mdx files for each exercise. The fields you must provide in the yaml are:
8488
- title: Title of the exercise (e.g. BST Difference)
8589
- desc: Brief description of exercise (e.g. Find the mininum distance between any two numbers in a binary search tree)
8690
- class: Which course this exercise is for (eg. COMP2521)
8791
- difficulty: Difficult rating (1=easy, 2=medium, 3=hard) (e.g. 2)
8892

89-
Note: Both the <course-offering>.mdx and <course-offering> folder **MUST** share the exact same name in order to work (e.g. file `1511-22T3.mdx` and folder `1511-22T3`)
93+
Note: Both the <course-offering>.mdx and <course-offering> folder **MUST** share the exact same name in order to work (e.g. file `1511-23T3.mdx` and folder `1511-23T3`)
9094

91-
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*)
95+
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*)

0 commit comments

Comments
 (0)