Skip to content

Commit

Permalink
Merge pull request #15 from ra3xdh/remove_autotools
Browse files Browse the repository at this point in the history
Remove autotools stuff and update README
  • Loading branch information
ra3xdh authored Jul 8, 2024
2 parents 3309c05 + 05acd8f commit 87cf3ab
Show file tree
Hide file tree
Showing 34 changed files with 60 additions and 4,605 deletions.
101 changes: 0 additions & 101 deletions Makefile.am

This file was deleted.

60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Description

QucsatorRF is a command line driven circuit simulator targeted for RF and microwave circuits.
It takes a network list in a certain format as input and outputs a Qucs XML dataset. This repository
also contians a QucsconvRF tool for data file formats conversion.

The Qucs-S project https://github.com/ra3xdh/qucs_s is a recommended GUI for both tools.

# Build instruction

## Dependencies

QucsatorRF uses CMake build system and has the following build dependencies:

* CMake
* Flex
* Bison
* Gperf
* Dos2unix
* ADMS is optional. It is disbaled by default and could be enabled using `-DWITH_ADMS=ON` flag

QucsatorRF has no runtime dependencies except the standard C++ library (libstdc++). ADMS is an optional.

Use the following command to install build dependencies on Debian/Ubuntu. Refer to your package manager
documentation for other platfroms.

~~~
sudo apt-get install build-essential cmake flex bison gperf dos2unix
~~~

## Linux

Perform the following step to build the project:

* Clone this git repository:
~~~
git clone https://github.com/ra3xdh/qucsator_rf
~~~
* Go to the source directory and create the build directory
~~~
cd qucsator_rf
mkdir build
~~~
* Configure project with Cmake; define the desired installation path using `CMAKE_INSTALL_PREFIX`.
~~~
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path_to_install/ ..
~~~
* Build and install the `qucsator_rf` and `qucsconv_rf`
~~~
make
make install
~~~

## Windows

Use MSYS2 environment to build QucsatorRF. Install the GCC compiler and use CMake.
The build procedure and dependencies are the same as for Linux version.


File renamed without changes.
Loading

0 comments on commit 87cf3ab

Please sign in to comment.