diff --git a/README.txt b/README.txt index d6f013fa547110e0af52b86d833e67c813695102..2b3d43c81d215a03cc64b099819de3900cbdee89 100644 --- a/README.txt +++ b/README.txt @@ -44,11 +44,29 @@ To kick start your website development we have created a pre-fabricated Pelican theme and project template with example content. While you can install the template anywhere you like, for this example, please clone the cwi-pelican-template in the root of -your Pelican virtual environment. Don't forget to use your own -username in the url:: +your Pelican virtual environment. + +You can clone the cwi-pelican template in one of two ways. First, you +can fork the repository from the Rhodecode server. Point your browser +to https://scm.cwi.nl/ITF/cwi-pelican-template, choose 'Fork' from the +options menu, choose a name for your clone, choose your repository +group and click 'Fork this Repository.' We recommend this method since +is assures that your clone resides on the Rhodecode server. Now clone +your fork to your local machine. Don't forget to use your own username +in the url:: + + git clone https://@scm.cwi.nl/ITF/cwi-pelican-template-fork cwi + +Second, you can clone the template directly to your local machine:: git clone https://@scm.cwi.nl/ITF/cwi-pelican-template cwi +This clone resides on your local machine. Its origin is read-only, so +you'll have to create a repository somewhere before you can push your +changes. See the 'Archiving your site' section below for instructions +how to create a remote Rhodecode repository. + + Installing the Pelican CWI theme -------------------------------- @@ -160,14 +178,21 @@ and document root configured for you by ITF staff. Archiving your site ------------------- -The url from which you cloned the cwi-pelican-template repository is -called the clone's 'origin.' To archive your clone you should change -its origin to point to a new repository and push it there. For -example, if I had created a new repository at scm.cwi.nl named -itf-pelican-site, I could push my site there with the following two -commands:: +the url from which you cloned the cwi-pelican-template repository is +called the clone's 'origin.'If you forked your clone you already have +a remote repository on the Rhodecode server. Your local clone knows +what its origin is, and you can push your changes directly to it. If, +however, you merely cloned the repository, you must change its origin +to point to a different remote repository before you can push your +changes. For example, if you had created a new repository at +scm.cwi.nl named test-pelican-site, you could change the origin of you +local clone with the following command:: git remote add origin https://guravage@scm.cwi.nl/ITF/itf-pelican-site + +Afterwards, you could push your changes to your remote, whether forked +or new, with the following command:: + git push -u origin master