Doc improved, added astyle to the install list

This commit is contained in:
Éder F. Zulian
2018-04-06 11:49:24 +02:00
parent 367f3eb9fd
commit f851de136c
4 changed files with 16 additions and 2 deletions

View File

@@ -1,5 +1,5 @@
# Relative paths to "DRAMSys/library" because this file is included in
# "DRAMSys/library/simulator.pro"
# "DRAMSys/library/library.pro"
# Simulation Files
OTHER_FILES += resources/simulations/ddr3-example.xml

View File

@@ -1,5 +1,5 @@
# Relative paths to "DRAMSys" because this file is included in
# "DRAMSys/dram.vp.system.pro"
# "DRAMSys/DRAMSys.pro"
OTHER_FILES += tests/start.pl

View File

@@ -51,6 +51,16 @@ describe the preferred coding style for them in separate.
+ How to use vim plugins
## Using Astyle in Qt Creator
+ Select **Help** > **About Plugins** > **C++** > **Beautifier** to enable the plugin.
+ Restart Qt Creator to be able to use the plugin (close Qt Creator and open it again).
+ Select **Tools** > **Options** > **Beautifier** to specify settings for beautifying files.
+ Select the **Enable auto format on file save** check box to automatically beautify files when you save them.
## References
@@ -60,3 +70,6 @@ describe the preferred coding style for them in separate.
[PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/)
[Qt Documentation - Beautifying Source Code](http://doc.qt.io/qtcreator/creator-beautifier.html)
[Artistic Style 3.1 - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, ObjectiveC, C#, and Java Source Code](http://astyle.sourceforge.net/astyle.html)

View File

@@ -55,3 +55,4 @@ sudo apt-get -y install libqt5widgets5
sudo apt-get -y install libqt5core5a
sudo apt-get -y install qtcreator
sudo apt-get -y install qt5-default
sudo apt-get -y install astyle