diff --git a/INSTALL b/INSTALL index d9c5a438..eb9a94f0 100644 --- a/INSTALL +++ b/INSTALL @@ -1,31 +1,16 @@ GENtle install hints -COMMON: - -Good luck! You'll need it... - -WINDOWS: - -We would welcome volunteers to step forward for whom Windows is their -regular development environment to help with providing executables for -that platform. - -From what we remember: -You can use Dev-C++ as development environment. ".dev" files are -included in the source. You'll need the latest wxWindows package (look -on the wxWindows site rather than the Dev-C++ site). - MAC OS: -This software was initially developed for the MacOS, at a time when the +This software was initially developed for the macOS, at a time when the PowerPC was a thing, still. We recently had success with Xcode, but that requires much tinkering to adapt to local install paths of the build-dependencies. We find it much easier to work with conda or homebrew (https://brew.sh). -For details, see the respective description of homebrew/conda below, i.e. +For details, see the respective description of homebrew/conda below in the Linux section. The application runs fine when started in situ directly after the compilation. -To facilitate the deployment on MacOS, we are providing the target "macos_bundle" +To facilitate the deployment on macOS, we are providing the target "macos_bundle" that, with the help of the additional package "dylibbundler" (provided by homebrew), assembles a folder named "GENtle.app" that can be copied as it is into the "Applications" folder on any Mac of the same architecture for a complete deployment. @@ -36,7 +21,8 @@ The Linux OS offers several routes to install GENtle: * Your Distributions's Package manager We are working closely with the Debian Linux distribution, try - "sudo apt install gentle" + "sudo apt install gentle". The state of the packaging can be + inspected on https://tracker.debian.org/pkg/gentle * Conda We have also provided a package for conda, add their channel @@ -64,4 +50,22 @@ To build your package from source, try - CXXFLAGS="-I/opt/homebrew/include" ./configure - make -j10 -Upon successful compilation, the executable "GENtle" can be started in situ. +Upon successful compilation, the executable "GENtle" can be started in the "src" folder. + +WINDOWS: + +We would welcome volunteers to step forward for whom Windows is their +regular development environment to help with providing executables for +that platform. + +From what we remember: +You can use Dev-C++ as development environment. ".dev" files are +included in the source. You'll need the latest wxWindows package (look +on the wxWindows site rather than the Dev-C++ site). + +You do not want to wait for an official Windows release: +GENtle works nicely with the Windows Subsystem for Linux (WSL). This +is surprisingly easy to install. If installing only for GENtle, use +Debian testing (bookworm) and install the regular Debian package. + + diff --git a/README.Linux.md b/README.Linux.md deleted file mode 100644 index 3229f4ad..00000000 --- a/README.Linux.md +++ /dev/null @@ -1,45 +0,0 @@ -# GENtle on Linux - -GENtle is available as a package for Debian and Ubuntu since 2010. You can easily install GENtle on your Linux distribution using the package manager. For Debian-based systems, you can find the exact version of GENtle available for your release and backport distribution channels on the [GENtle Debian tracker page](https://tracker.debian.org/pkg/gentle). - -## Installation - -To install GENtle on Debian or Ubuntu, open a terminal and run the following command: - -```bash -sudo apt-get install gentle -``` - -This command will install the GENtle package along with all its dependencies. - -## Running GENtle - -After installation, you can start the application by typing `GENtle` in the UNIX command line, or you can find GENtle in the "Science" submenu of your application menu. - -## Compiling from Source - -If you prefer to compile GENtle from source on Debian or Ubuntu independently from the package maintainers' routines, follow these steps: - -1. Install the required packages: - -```bash -sudo apt-get install libwxgtk3.2-dev automake1.9 libmysql++-dev libsqlite0-dev libsqlite3-dev -``` - -2. Perform the usual compilation steps: - -```bash -./configure -make -``` - -## Note for Other Linux Distributions - -For users of other Linux distributions, you may need to slightly adjust the package names of the build dependencies mentioned above based on your distribution's package manager. Refer to your distribution's documentation or package repository for appropriate package names. - -## Contributing to Packaging - -If you are familiar with packaging for Linux distributions and would like to contribute to the packaging of GENtle for any Linux variant, we welcome your assistance. Feel free to reach out to us to discuss how you can help. - -We hope you find GENtle valuable for your molecular biology research and experimentation. -If you encounter any issues or have questions, please don't hesitate to contact us for support. diff --git a/README.md b/README.md index c0ba38b7..9700a57b 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,5 @@ Please also inspect the GENtle is released as free and open-source software under the GPLv2+ license. You can access the source code in the repository [here](https://github.com/GENtle-persons/gentle-m). + + diff --git a/docs/images/GENtle_DNA_forming_image.png b/docs/images/GENtle_DNA_forming_image.png new file mode 100755 index 00000000..94ce1457 Binary files /dev/null and b/docs/images/GENtle_DNA_forming_image.png differ