Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
yhoogstrate committed Jan 20, 2022
1 parent d1c93c3 commit 904e501
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,44 +47,43 @@ Required dependencies are:
- libopenssl (for generating MD5 hashes)
- libfuse (for access to the fuse layer system and file virtualization)
- c++ compiler supporting c++-14
- glibc
- libssl (for checking sequences with ENA)
- zlib (crc32 checksum)
- cmake or meson + ninja-build
- libcrypto for MD5sums


### For debian + ubuntu:

sudo apt install git build-essential cmake libboost-dev libssl-dev libboost-test-dev libboost-system-dev libboost-filesystem-dev zlib1g-dev libzstd-dev libfuse-dev

## First install libzstd:

This is currently done by running:

```
cd dependencies/zstd
make
sudo make install
sudo apt install git build-essential cmake libboost-dev libssl-dev libboost-test-dev libboost-system-dev libboost-filesystem-dev zlib1g-dev libzstd-dev libfuse-dev
git clone https://github.com/yhoogstrate/fastafs.git
cd fastafs
```

Indeed, we should patch the cmake config to do this automatically.

## Compilation

Compilation is done using cmake. The build command to run cmake for common use is:

Compile (release, recommended):
```
#!/bin/bash
cmake -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON .
make "$@" -j `nproc`
sudo make install
```

If you do not have root permission, use the following instead:
```
cmake -DCMAKE_BUILD_TYPE=release -DCMAKE_INSTALL_PREFIX=~/.local -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON .
make "$@" -j `nproc`
make install
```

If you like to play with the code and like to help development, you can create a debug binary as follows:

```
$ cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=~/.local -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON .
$ make "$@" -j `nproc`
$ make install
cmake -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON .
make "$@" -j `nproc`
sudo make install
```


If you have patches, changes or even cool new features you believe are worth contributing, please run astyle with the following command:

```
Expand Down

0 comments on commit 904e501

Please sign in to comment.