readme improved
This commit is contained in:
31
README.md
31
README.md
@@ -16,18 +16,16 @@ $ mkdir projects
|
||||
$ cd projects
|
||||
```
|
||||
|
||||
Configure git on your machine. Some basic configurations follow:
|
||||
Configure git on your machine. Some basic configurations follow. Replace
|
||||
**rhrkuser** with your own RHRK user when configuring your email.
|
||||
|
||||
``` bash
|
||||
$ git config --global user.name "FirstName OtherNames LastName"
|
||||
$ git config --global user.email user@rhrk.uni-kl.de
|
||||
$ git config --global user.email rhrkuser@rhrk.uni-kl.de
|
||||
$ git config --global credential.helper ’cache --timeout=3600’
|
||||
$ git config --global color.ui auto
|
||||
```
|
||||
|
||||
In **user@rhrk.uni-kl.de** replace the word **user** in order to get your
|
||||
own RHRK email account.
|
||||
|
||||
Login using your **git.rhrk** account. Fork the repository by clicking in
|
||||
**Fork** in the upper-right corner of this page.
|
||||
|
||||
@@ -80,8 +78,18 @@ $ git submodule update --init --recursive
|
||||
|
||||
### Dependencies
|
||||
|
||||
Make sure you have properly installed in your system the required libraries.
|
||||
They are:
|
||||
Make sure you have properly installed in your system the required libraries
|
||||
and programs.
|
||||
|
||||
- General dependencies
|
||||
|
||||
You can use [install.sh](./install.sh) in order to install dependencies. First
|
||||
read and understand the script than execute it. Type your password if
|
||||
required.
|
||||
|
||||
```bash
|
||||
$ bash install.sh
|
||||
```
|
||||
|
||||
- SystemC 2.3.1 and TLM 2.0
|
||||
|
||||
@@ -107,15 +115,6 @@ $ bash getqwt.sh
|
||||
|
||||
For further information refer to [this](http://qwt.sourceforge.net/)
|
||||
|
||||
- python3.5 or 3.6 and other dependencies
|
||||
|
||||
You can use [install.sh](./install.sh) in order to install dependencies. First
|
||||
read and understand the script than execute it.
|
||||
|
||||
```bash
|
||||
$ bash install.sh
|
||||
```
|
||||
|
||||
To grant flexibility to the user the paths where to find some essential
|
||||
libraries and headers can be specified with environment variables. You can add
|
||||
such variables to you ~/.bashrc file or equivalent.
|
||||
|
||||
Reference in New Issue
Block a user