Skip to content

Commit e3ced61

Browse files
Merge branch 'README' into develop
2 parents 00b8b2f + 64121cd commit e3ced61

File tree

1 file changed

+37
-41
lines changed

1 file changed

+37
-41
lines changed

README.md

Lines changed: 37 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -77,63 +77,57 @@ Compilation and installation depends on the operation system. See below for an e
7777

7878
Some general contribution guidelines can be found on our Wiki <https://github.com/Qucs/qucs/wiki/Contribution>.
7979

80-
## Compile instructions Linux (Debian/Ubuntu)
80+
## More compile instructions on GNU/Linux
8181

82-
For the GUI tools and simulation engine the following dependencies are needed:
82+
(This section may be outdated. Find up to date documentation in */README.md)
8383

84-
sudo apt-get install build-essential
85-
sudo apt-get install libqt4-dev libqt4-qt3support
86-
sudo apt-get install automake libtool libtool-bin gperf flex bison
84+
For the GUI tools and simulation engine the following packages are required
85+
when building from git (package names on non-Debian may vary).
8786

88-
The ADMS package is necessary. Please [download](https://sourceforge.net/projects/mot-adms/files/adms-source/) the latest tarball and follow the [install](https://github.com/Qucs/ADMS#users-install-from-tarball) instructions. Having `admsXml` on the path should be sufficient.
87+
adms automake build-essential libqt4-dev libqt4-qt3support libtool libtool-bin
88+
gperf flex bison pkg-config
8989

90-
To build the manuals and user documentation further dependencies are needed. Please check the `qucs-doc/README` file.
91-
See below the `--disable-doc` to skip building the documentation from source.
92-
To build the documentation from source the following dependencies are needed:
90+
To build the manuals and user documentation further dependencies are needed.
91+
Please check the `qucs-doc/README` file. See below the `--disable-doc` to skip
92+
building the documentation from source. To build the documentation from source
93+
the following packages are needed (package names on non-Debian may vary).
9394

94-
sudo apt-get install doxygen
95-
sudo apt-get install octave octave-epstk
96-
sudo apt-get install latex2html
97-
sudo apt-get install texlive texlive-font-utils texlive-math-extra
98-
sudo apt-get install texlive-publishers texlive-science
99-
sudo apt-get install transfig gnuplot graphviz
100-
sudo apt-get install ps2eps pgf python-tk
95+
doxygen latex2html octave octave-epstk ps2eps pgf python-tk
96+
texlive-publishers texlive-science texlive texlive-font-utils
97+
texlive-math-extra transfig gnuplot graphviz
10198

102-
Bootstrap and build everything (after cloning):
99+
Bootstrap, build, install everything (after cloning):
103100

104-
cd qucs
105-
./bootstrap
106-
./configure
107-
make
108-
sudo make install
101+
$ cd qucs
102+
$ ./bootstrap
103+
$ ./configure
104+
$ make
105+
$ sudo make install # optional
109106

110107
Compile Qucs GUI tools only:
111108

112-
cd qucs
113-
[./bootstrap] #if not executed in the top level
114-
./configure
115-
make
116-
sudo make install
109+
$ cd qucs
110+
$ [./bootstrap] #if not executed in the top level
111+
$ ./configure
112+
$ make
117113

118114
Compile qucs-core tools only:
119115

120-
cd qucs-core
121-
[./bootstrap] #if not executed in the top level
122-
./configure
123-
make
124-
sudo make install
116+
$ cd qucs-core
117+
$ [./bootstrap] #if not executed in the top level
118+
$ ./configure
119+
$ make
125120

126121
Compile qucs-doc documentation only:
127122

128-
cd qucs-doc
129-
[./bootstrap] #if not executed in the top level
130-
./configure
131-
make
132-
sudo make install
123+
$ cd qucs-doc
124+
$ [./bootstrap] #if not executed in the top level
125+
$ ./configure
126+
$ make
133127

134-
Testing can be executed at the top level with:
128+
Tests may be executed at the top level with:
135129

136-
make check
130+
$ make check
137131

138132
Note:
139133

@@ -144,9 +138,11 @@ Note:
144138
To use a different `admsXml` pass the option `--with-admsxml=[path/to/]anotherAdmsXml`
145139
to `./configure`.
146140

147-
* The LaTex documentation compilation in qucs-doc can be skipped passing `--disable-doc` to the top level `configure` script.
141+
* The LaTex documentation compilation in qucs-doc can be skipped passing
142+
`--disable-doc` to the top level `configure` script.
148143

149-
* Consider the output of `./configure --help` for more and definitive build options.
144+
* Consider INSTALL and the output of `./configure --help` for more and
145+
definitive build options.
150146

151147

152148
## Binary Installation

0 commit comments

Comments
 (0)