Skip to content

Improve README with project structure and contributor setup #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rachana192837 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README with project structure and contributor setup #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# Liquid Galaxy
## Project Structure

This repository contains the core components required to deploy and manage
a Liquid Galaxy system.

- `install.sh` – Main installation and setup script
- `gnu_linux/` – Configuration files and Linux-specific setup
- `php-interface/` – Web-based control interface for Liquid Galaxy
- `assets/` – Media and supporting resources

# Before Installation

Expand All @@ -11,6 +20,18 @@ $ sudo apt upgrade -f .

## Installation

## Development Setup (For Contributors)

This repository can also be used for development, testing, and documentation
improvements without running the full Liquid Galaxy setup.

### Getting Started
1. Fork this repository on GitHub
2. Clone your fork locally:
```bash
git clone https://github.com/<your-username>/liquid-galaxy.git
cd liquid-galaxy

The installation script (`install.sh`) is intended to be used with Ubuntu. It might not work
with other distributions.

Expand Down