Skip to content

Commit

Permalink
Streamline DX for Ubuntu 20 (#69)
Browse files Browse the repository at this point in the history
* Add documentation of what packages to install for Ubuntu build.

* Harmonize Readme markup.
  • Loading branch information
mittinatten committed Oct 19, 2021
1 parent 4cd38ac commit 7444933
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
language: c++
git:
depth: 3
dist: xenial
dist: focal
cache: pip

before_install:
Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,9 @@ After cloning the repository, add git submodules

FreeSASA can be compiled and installed using the following

```sh
autoreconf -i # only if cloned from the git-repo
autoreconf -i # only necessary if you're cloning git repo
./configure
make && make install
```

NB: If the source is downloaded from the git repository the
configure-script needs to be set up first using `autoreconf -i`. Users
Expand Down Expand Up @@ -140,6 +138,18 @@ It should be relatively straightforwad to build the command line tool for
Windows using MinGW or Cygwin, but this hasn't been tested (let me know if
you've got it to work).

### Prerequisites for Ubuntu

The following command will install all dependencies needed, some of which most users will already have,
for a minimal build of FreeSASA in Ubuntu (verified for version 16, 18 and 20).

apt-get update
apt-get install git build-essential autoconf libc++-dev libc++abi-dev

For a fully featured build, with ability to run unit tests, these additional packages are needed

apt-get install check libjson-c-dev libxml2-dev libxml2-utils

## Citing FreeSASA

FreeSASA can be cited using the following publication
Expand Down

0 comments on commit 7444933

Please sign in to comment.