Skip to content

Commit bf401f5

Browse files
committed
add readme
1 parent bd144fd commit bf401f5

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Memory Layout Manager for Single and MultiCore Systems
2+
[![Build Status](https://travis-ci.org/tompollard/phd_thesis_markdown.svg?branch=master)](https://travis-ci.org/tompollard/phd_thesis_markdown)
3+
4+
The memory layout manager is a simple GUI, which should help to parse and
5+
verify linker scripts projects.
6+
7+
I recommend to use Netbeans IDE 8.x, because the bison support is working out
8+
of the box. Otherwise, I would recommend and install a plugin for bison flex.
9+
10+
## Installation
11+
12+
A toolchain is provided to start the project out of the box.
13+
14+
* Bison 3.0.4
15+
* Flex 2.6.1
16+
* WxWidgets 3.1.0
17+
* C++11 >= 6
18+
19+
Go in the root folder and execute
20+
`./install_tc.sh`.
21+
It will last around 40 minutes.
22+
23+
In Windows, you need to run a bash window first. [Activate bash shell](http://www.windowscentral.com/how-install-bash-shell-command-line-windows-10)
24+
in Windows 10.
25+
26+
In Arch Linux, it is recommended to take a look to [Link](https://wiki.filezilla-project.org/Compiling_FileZilla_3_under_Windows)
27+
28+
## Usage
29+
30+
make help // shows you a list of options
31+
32+
Find a graphical overview of the grammar, klick [here](#Grammar-Overview).
33+
34+
## History
35+
36+
This file started with LinkerScript Parser v0.0 and tracks the feature of this tool.
37+
Each line will describe a single addition/removement/change and adhere to the following format:
38+
39+
`<Author> <Type> : <Textual_description_without_linebreak>`
40+
41+
Authors (so far):
42+
43+
* MB Marcel Baunach
44+
* RG Renata Gomes
45+
* PL Peter Lorenz
46+
47+
Type:
48+
49+
* \+ Addition
50+
* \- Removement
51+
* \# Modification
52+
* \~ Fix
53+
* \! Misc.
54+
* (very significant entries should be in upper case and prefixed with "-----" )
55+
56+
Table of changes:
57+
58+
* `PL + The initial setup is done. Version 0.0`
59+
* todo add changes
60+
61+
## Credits
62+
63+
* Master Project, written by Peter Lorenz.
64+
* Marcel Baunach and Renata Gomez supervised this project.
65+
66+
## License
67+
68+
GNU General Public License v3.0
69+
70+
---
71+
72+
### Grammar-Overview
73+
Go to development/parser/output/parser.png

0 commit comments

Comments
 (0)