Highly Available and Scalable Information System
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Guillaume REMBERT edd103821a Update par2 cli options due to changes 3 years ago
cfg/sw Minor corrections 4 years ago
sw/src Update par2 cli options due to changes 3 years ago
LICENSE Initial commit 4 years ago
README Fix non-TTY envs + local repositories as option + better failure management 4 years ago

README

-------------------------------
Project: EuryBOX
Version: 1.0.0
Status: beta
-------------------------------
Author(s):
Guillaume REMBERT
-------------------------------
License:
MIT - Please read LICENSE file for more information
-------------------------------


-------------------------------
README INDEX
-------------------------------
0 - Project Presentation
-------------------------------
This section presents the EuryBOX project.
Start first by reading these lines.
-------------------------------
1 - Repository Structure
-------------------------------
This section presents the repository structure.
Read these lines to understand the files layout.
-------------------------------
2: Integration Methodology
-------------------------------
This section presents a methodology to be used to integrate the solution.
Read these lines to check and/or define your integration plan.
-------------------------------
3: Development Guidelines
-------------------------------
This section presents coding style conventions.
Read these lines to modify and/or extend the system.
-------------------------------
4: Quick Start
-------------------------------
This section summarizes what is needed to setup and run the solution.
Read these lines to build, install and start the system.
-------------------------------


-------------------------------
PART 0 - PROJECT PRESENTATION
-------------------------------
FIXME: TBD / Features, supported platforms, etc
-------------------------------


-------------------------------
PART 1 - REPOSITORY STRUCTURE
-------------------------------
\ cfg (ConFiGuration): configuration files
-------------------------------
\ hw (HardWare): physical configuration elements
\ sw (SoftWare): logical configuration elements
-------------------------------
\ doc (DOCumentation): documentation
-------------------------------
\ ddd (Detailed Design Document): architecture, algorithms and design details
\ icd (Interface Control Document): API, internal and external files formats description
\ trp (Test RePorts): stable releases test reports
\ ugd (User GuiDe): installation, configuration and use guide
-------------------------------
\ hw (HardWare): hardware data
-------------------------------
\ bom (Bill Of Materials)
\ dts (DaTaSheets)
-------------------------------
\ sw (SoftWare): software data
-------------------------------
\ bin (BINaries): qualified binaries
\ RELEASE_VERSION_X.XX.XX
\ SOFTWARE_NAME-x86_64_X.XX.XX-gcc_X.XX.XX-glib_X.XX.XX
\ pkg (PacKaGes): platform specific installation packages
\ RELEASE_VERSION_X.XX.XX
\ SOFTWARE_NAME
\ apk: Android
\ bsd: BSD Unix
\ deb: Debian/Ubuntu Linux
\ ios: iOS
\ rpm: RedHat/CentOS/Fedora/OpenSUSE Linux
\ win: Windows
\ src (SouRCes): software source code
\ administration_center
\ core
\ backup
\ destruction
\ management
\ restoration
\ scheduling
\ transfer
\ creation_center
\ core
\ build
\ configuration
\ test
\ version
\ applications
\ communication
\ finances
\ planning
\ research
\ resources
\ security
\ support
\ exploitation_center
\ core
\ diagnostic
\ deployment
\ installation
\ inventory
\ maintenance
\ monitoring
\ reparation
\ update
\ quality_center
\ core
\ audit
\ reproduction
\ validation
-------------------------------
\ tst (TeST): test tools and data-sets
-------------------------------
\ sh (SHell)
\ eurybox_auto_test
-------------------------------


-------------------------------
PART 2: INTEGRATION METHODOLOGY
-------------------------------
FIXME: TBD / Specs -> Design -> Code -> Test
-------------------------------


-------------------------------
PART 3: DEVELOPMENT GUIDELINES
-------------------------------
FIXME: TBD / variables / functions / comments / ...
-------------------------------


-------------------------------
PART 4: QUICK START
-------------------------------
FIXME: TBD / HW and SW requirements, OS setup, build, install, test
-------------------------------