fix(docs): improved readability in READ.md (#46883)

Co-authored-by: Jeremy L Thompson <jeremy@jeremylt.org>
Co-authored-by: Mrugesh Mohapatra <1884376+raisedadead@users.noreply.github.com>
This commit is contained in:
Rutvikk :D
2022-07-15 12:49:24 +05:30
committed by GitHub
parent a0b0942692
commit 0390c71c1f
+6 -4
View File
@@ -1,8 +1,10 @@
# Getting Started
If you haven't installed freeCodeCamp proper yet, that needs to happen first.
Step 1 : Install freeCodeCamp properly on your system.
Once that's done, the curriculum server and this package need installing. Then the prepare script will take care of the rest.
Step 2 : Install the curriculum server and the current package.
Step 3 : The prepare script will take care of the rest.
```sh
cd ../curriculum-server
@@ -26,9 +28,9 @@ is the curriculum data that is currently being used.
## Things of Note
Incremental static regeneration is working quite nicely. You can modify the curriculum data (in /curriculum-server/data/curriculum.json), refresh reload your browser and the changes will be reflected.
Incremental static regeneration is working quite nicely. You can modify the curriculum data (in /curriculum-server/data/curriculum.json), refresh/reload your browser and the changes will be reflected.
The trailing ids are a bit buggy, but you can replace them with a new page's mongo id and it ~should~ will refresh.
The trailing ids are a bit buggy, but you can replace them with a new page's mongo id and it will refresh.
Also, mangled paths _mostly_ work. For example: