Skip to content

Commit cc27410

Browse files
authored
Merge pull request #168 from periperidip/edit_setup
Edit setup
2 parents 8e40865 + dcf0a77 commit cc27410

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,6 @@
11
# su2code.github.io
22
[Link to Website](https://su2code.github.io/)
3+
4+
## For Developers
5+
6+
In order to make any changes in the documentation of SU2, the files in [_docs_v7/](_docs_v7) should be touched. This is the documentation which is currently online.

_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ permalink: /docs_v7/Developing-SU2-on-GitHub-(Internal-Developers)/
55

66
The repository for SU2 is being hosted here on GitHub. As you are likely aware, GitHub is simply an online project hosting service with a very useful web interface and additional tools to aid code development with Git as its backbone. Git is a version control system (VCS) that is similar to SVN, Mercurial, etc., and it helps organize the development of code over time by tracking changes.
77

8-
To get started, you need to create a personal user account on GitHub (free) and follow the [basic setup instructions](https://help.github.com/articles/set-up-git). These instructions include how to get Git installed on your local machine. To sync up your local settings with GitHub, change the user.email and user.name variables for your local git configuration with
8+
To get started, you need to create a personal user account on GitHub (free) and follow the [basic setup instructions](https://help.github.com/articles/set-up-git). These instructions include how to get Git installed on your local machine. To sync up your local settings with GitHub, change the `user.email` and `user.name` variables for your local git configuration with
99
```
10-
git config --global user.email "[email protected]"
11-
git config --global user.name "Your Name"
10+
git config --local user.email "[email protected]"
11+
git config --local user.name "Your Name"
1212
```
1313
Note that the email address should be the one associated with your GitHub account.
1414

@@ -22,6 +22,7 @@ After cloning, you should have a new SU2/ folder in your current working directo
2222
```
2323
git log
2424
```
25+
To setup the local copy of SU2 for development purposes, one must follow the steps mentioned in [Build-SU2-Windows](_docs_v7/Build-SU2-Windows.md) and [Build-SU2-Linux-MacOS](_docs_v7/Build-SU2-Linux-MacOS.md).
2526

2627
## Typical Workflow with Git
2728

0 commit comments

Comments
 (0)