Skip to content

Commit 2162cf9

Browse files
Update docs
1 parent 1f0f673 commit 2162cf9

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/installation.rst

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Quick Start
1313
copier gh:igembitsgoa/igem-wiki-starter wiki
1414
cd wiki
1515
npm install
16+
pip install -r requirements.txt
1617
npm start
1718
1819
Detailed Guide
@@ -38,13 +39,11 @@ It now shows the following prompts:
3839

3940
* ``iGEM_team_code``
4041
* ``iGEM_team_name``
41-
* ``year``
42-
* ``github_username``
43-
* ``github_repository``
42+
* ``year``
4443
* ``author``
4544
* ``email``
4645

47-
Next, go inside the directory that you created (``github_repository``) and execute the following to install Node dependencies::
46+
Next, go inside the directory that you created and execute the following to install Node dependencies::
4847

4948
npm install
5049

@@ -56,6 +55,18 @@ Installation is complete now and you can start the webpack development server by
5655

5756
npm start
5857

58+
It is recommended that you set up `version control <https://www.youtube.com/watch?v=9GKpbI1siow>`_ for your wiki by `creating a Github repository <https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-new-repository>`_ right away.
59+
60+
This will not only make development easier, but also allow you to try out your wiki on your github.io URL before uploading it to iGEM servers. Besides, you can set up Github Actions to automatically deploy your wiki directly from Github to iGEM servers. A detailed tutorial on this subject will soon be available here.
61+
62+
To do that, create an empty Github repository and initialize it and set up the remote by executing the following in the folder you have created::
63+
64+
git init
65+
git add --all
66+
git commit -m "Initial commit"
67+
git remote add origin <your Github repository URL>
68+
git push --set-upstream origin master
69+
5970
Please send us an email at igembitsgoa@gmail.com if you need any help with installation.
6071

6172
.. # TODO: #2 Add Cookiecutter prompt details

0 commit comments

Comments
 (0)