PhyloSkims/annotate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.txt to switch to Markdown format

Browse Source 
Former-commit-id: 62b255841b6cb935edd9faef126eb1b133366df3
Former-commit-id: a9af4e20cc1b0bcdc01a45cb890dfee8b9b75a5c
This commit is contained in:
Eric Coissac
2021-11-08 10:20:23 +01:00
parent 9648bbb874
commit 1eb97d34ff
1 changed files with 58 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
README.txt
View File

@ -1,57 +1,60 @@
#
# ------------------------------------------
# ORG.Annot - Organelle Annotator # ORG.Annot - Organelle Annotator
# version 1.0.0 - Sept 2015
# ------------------------------------------ **version 1.0.0 - Sept 2015**
#
# ------------------------- ## -1- Installation
# -1- Installation
# -------------------------
#
# First check if binaries have been already compiled for your port # First check if binaries have been already compiled for your port
#
# $ scripts/check_port.sh ```bash
# scripts/check_port.sh
# if it prints : ```
#
# + checking port compilation OK if it prints :
#
# then everything is fine ```
# checking port compilation OK
# if it prints : ```
#
# + port not yet compiled then everything is fine
#
# then, you should first compile binaries for your port if it prints :
# please consult: src/README.txt for details
# ```
# if it prints smthing like port not yet compiled
# * XXX version A.B.C (should be >= X.Y.Z) ```
# * please consider installing XXX from src/_unix_tools_
# then, you should first compile binaries for your port
# then, you should first compile some unix tools binaries for your port please consult: src/README.txt for details
# please consult: src/README.txt for details
# if it prints something like
# -------------------------
# -2- Distribution organisation ```
# ------------------------- XXX version A.B.C (should be >= X.Y.Z)
# please consider installing XXX from src/_unix_tools_
# config : config file for (re)compiling tools ```
# data : internal data files (e.g. ChloroDB)
# detectors : features specific detector scripts then, you should first compile some unix tools binaries for your port
# ports : binaries for various ports please consult: `src/README.txt` for details
# scripts : main scripts directory
# src : sources for (re)compiling tools ## -2- Distribution organisation
#
# -------------------------
# -3- Usage - config : config file for (re)compiling tools
# ------------------------- - data : internal data files (e.g. ChloroDB)
# - detectors : features specific detector scripts
# note: all scripts are located in scripts, so you may add - ports : binaries for various ports
# this directory in your path - scripts : main scripts directory
# e.g. using csh - src : sources for (re)compiling tools
# set path = ($path <ROOTDIR>/scripts)
# ## -3- Usage
# @TODO : scripts description
#
# test > note: all scripts are located in scripts, so you may add
> this directory in your path
> e.g. using csh
> set path = ($path <ROOTDIR>/scripts)
@TODO : scripts description
test