-
Notifications
You must be signed in to change notification settings - Fork 119
Basic Setup
To contribute to the JLESC website, only a few very basic things are required on your computer:
-
Linux or OSX operating system.
❗ Windows is not tested and will most likely mess things up. ❗
-
your favourite plain text editor 1
potentially with Markdown support (i.e. syntax higlighting)
For people contributing on a regular basis or handing in larger changes, we strongly recommend setting up a local environment to test the site locally.
These steps are usually only required to be done once (unless you really mess something up 😉).
-
Get yourself a GitHub account It is free and no hidden costs are burried.
-
Log into your GitHub account. All following steps are assuming you are logged in.
-
Fork the JLESC website repository to your account.
This creates a non-synchronised copy of the website repository in your account.
-
Setup Git
For the sake of clarity and to avoid confusion with your collegues, please use your real (full) name (as you do on papers) and your email address of your official JLESC affiliation (i.e. ANL, JSC, etc.) -
Configure SSH
We strongly encourage people to use SSH and NOT HTTPS! -
Find yourself a nice place for the JLESC website repository to live in on your computer, e.g.
$HOME/projects
:cd $HOME/projects
-
Clone the JLESC website repository:
git clone [email protected]:JLESC/jlesc.github.io cd jlesc.github.io
-
Configure your personal fork:
git remote add myone [email protected]:<YOUR_GITHUB_USERNAME>:jlesc.github.io
Hopefully, it is obvious that you replace
<YOUR_GITHUB_USERNAME>
above with your actual GitHub username, i.e.torbjoernk
1: In general it is also possible to add and modify the content without leaving GitHub and the comfort of the web browser. However, we will not discuss this option here as we advice against it.
Please, by all means, notify us when anything is unclear in this wiki or the in-source documentation!