Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Paulo V C Medeiros committed Mar 18, 2015
1 parent 05b00c3 commit 2512683
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<!-- ============================================================================= -->
BandUP: Band Unfolding code for Plane-wave based calculations
======================================================================================
### Please visit http://www.ifm.liu.se/theomod/compphys/band-unfolding

#### Copyright (C) 2013-2015 Paulo V. C. Medeiros - paume@ifm.liu.se
############################################################################
### BandUP: Band Unfolding code for Plane-wave based calculations
############################################################################
###### Copyright (C) 2013-2015 Paulo V. C. Medeiros - paume@ifm.liu.se
##### Please visit http://www.ifm.liu.se/theomod/compphys/band-unfolding

BandUP is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand All @@ -19,7 +18,7 @@ You should have received a copy of the GNU General Public License
along with BandUP. If not, see <http://www.gnu.org/licenses/>.

<!-- ============================================================================= -->
Plane-wave codes currently supported by BandUP
#### Plane-wave codes currently supported by BandUP
--------------------------------------------------------------------------------------
* At the moment, BandUP can parse wavefunctions generated by:
* VASP
Expand All @@ -33,7 +32,7 @@ Plane-wave codes currently supported by BandUP
we'd only need to write an interface to it :)

<!-- ============================================================================= -->
How to compile BandUP
#### How to compile BandUP
--------------------------------------------------------------------------------------
* Run the "build.sh" script: ./build.sh
* A folder named "BandUP_bin" will be created.
Expand All @@ -42,7 +41,7 @@ How to compile BandUP
* Do check, however, the system requirements below if you have any problem.

<!-- ============================================================================= -->
System requirements:
#### System requirements:
--------------------------------------------------------------------------------------
* Preferably Linux
* Might work in other environments based on Unix
Expand All @@ -62,7 +61,7 @@ System requirements:
in the command line, just as usual.
<!-- ============================================================================= -->
Publications:
#### Publications:
--------------------------------------------------------------------------------------
* If you use BandUP (or any part or modified version of it) in your work, please:
* State that you've used the BandUP code (or a modified version fo it).
Expand All @@ -79,7 +78,7 @@ Publications:


<!-- ============================================================================= -->
Tips:
#### Tips:
--------------------------------------------------------------------------------------
* BandUP accepts some optional command line arguments and flags. To know them,
run the code with the flag '-help'.
Expand All @@ -93,7 +92,7 @@ Tips:


<!-- ============================================================================= -->
Please mind that:
#### Please mind that:
--------------------------------------------------------------------------------------
* Although I've tried to make the compilation as simple as possible - and it has
indeed worked fine so far with many combinations of compilers, computers, and
Expand Down

0 comments on commit 2512683

Please sign in to comment.