diff --git a/website/README.md b/website/README.md index 32d0e818bb..136733e725 100644 --- a/website/README.md +++ b/website/README.md @@ -12,25 +12,27 @@ $ npm ### Local Development -First, ensure you have setup MACI: +First, ensure you have setup MACI. + +From the root of the project (not within this `/website/` directory), run: ``` npm install && npm run bootstrap && npm run build ``` -Then, generate the typedoc documentation: +Then, generate the TypeDoc documentation: ``` npm run typedocs ``` -Now, please navigate to the `contracts` directory and generate the Solidity documentation: +Now, please navigate to the `/contracts/` directory and generate the Solidity documentation: ``` npm run docs ``` -At this point, we need to copy the generated documentation into the `website` directory, as well as generate a local index file for the Solidity documentation. Finally, we would need to replace the links of the typedoc html files to ensure that there are no broken links. To do this, we have two custom scripts which can be run as follows: +At this point, we need to copy the generated documentation into the `/website/` directory, as well as generate a local index file for the Solidity documentation. Finally, we need to replace the links of the TypeDoc HTML files to ensure that there are no broken links. To do this, we have two custom scripts to run: ``` npm run setup-typedoc @@ -39,7 +41,7 @@ npm run setup-soliditydocs The commands above will run the scripts inside (`./src/scripts`). -Finally, you can start the local development server: +Finally, start the local development server: ``` $ npm start @@ -53,4 +55,4 @@ This command starts a local development server and opens up a browser window. Mo $ npm build ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. Please note that it also generates the correct links for the typedoc files, as well as copies over the Solidity documentation from the contracts folder. Please ensure you have generated both typedoc and solidity documentation following the instructions above. +This command generates static content into the `/build/` directory and can be served using any static contents hosting service. Please note that it also generates the correct links for the TypeDoc files, as well as copies over the Solidity documentation from the contracts folder. Please ensure you have generated both TypeDoc and Solidity documentation following the instructions above.