Add project documentation and update README
Added detailed documentation files for code of conduct, contributing guidelines, core concepts, features, and project structure in the documentation/ directory. Updated README.md to reference new documentation, expand feature descriptions, and clarify setup instructions.
This commit is contained in:
@@ -2,15 +2,19 @@
|
||||
|
||||

|
||||
|
||||
A customizable and privacy-focused web browser built with Electron.
|
||||
A customizable and privacy-focused web browser built with Electron. Nebula is designed to be a lightweight, secure, and user-friendly browser with a focus on performance and privacy.
|
||||
|
||||
## Features
|
||||
|
||||
* **Privacy Control:** Easily clear your browsing data, including history, cookies, and cache.
|
||||
* **Tab Management:** Open new tabs, and manage them efficiently.
|
||||
* **Bookmarks:** Save your favorite sites.
|
||||
* **History:** Keeps track of your browsing and search history.
|
||||
* **Performance Monitoring:** Built-in tools to monitor application performance.
|
||||
* **GPU Acceleration Control:** Advanced settings to manage GPU acceleration and troubleshoot rendering issues.
|
||||
* **Cross-Platform:** Runs on Windows, macOS, and Linux.
|
||||
|
||||
|
||||
[**Learn more about Nebula's features.**](documentation/FEATURES.md)
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -28,9 +32,9 @@ A customizable and privacy-focused web browser built with Electron.
|
||||
```sh
|
||||
cd NebulaBrowser
|
||||
```
|
||||
3. Install Electron:
|
||||
3. Install dependencies:
|
||||
```sh
|
||||
npm install --save-dev electron@latest
|
||||
npm install
|
||||
```
|
||||
|
||||
### Running the Application
|
||||
@@ -51,6 +55,30 @@ npm run dist
|
||||
|
||||
This will create a distributable file in the `dist` directory.
|
||||
|
||||
## Project Structure
|
||||
|
||||
An overview of the project's structure. For a more detailed explanation, please see the [Project Structure documentation](documentation/PROJECT_STRUCTURE.md).
|
||||
|
||||
- `main.js`: The main entry point for the Electron application.
|
||||
- `renderer/`: Contains all the front-end files.
|
||||
- `preload.js`: Bridges the main and renderer processes.
|
||||
- `performance-monitor.js`: Module for monitoring performance.
|
||||
- `gpu-config.js` & `gpu-fallback.js`: Modules for managing GPU settings.
|
||||
- `assets/`: Contains static assets.
|
||||
- `documentation/`: Contains additional documentation.
|
||||
|
||||
## Core Concepts
|
||||
|
||||
Nebula is built on several core concepts that are essential to understanding how it works. For a deeper dive, read the [Core Concepts documentation](documentation/CORE_CONCEPTS.md).
|
||||
|
||||
- **Main and Renderer Processes**
|
||||
- **Inter-Process Communication (IPC)**
|
||||
- **Performance and GPU Management**
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please read our [contributing guidelines](documentation/CONTRIBUTING.md) to get started.
|
||||
|
||||
## Technologies Used
|
||||
|
||||
* [Electron](https://www.electronjs.org/)
|
||||
@@ -64,4 +92,8 @@ This project is licensed under the MIT License. [Read More](documentation/MIT.md
|
||||
## Documentation
|
||||
|
||||
* [MIT Licese](documentation/MIT.md)
|
||||
* [GPU Fix](documentation/GPU-FIX-README.md)
|
||||
* [GPU Fix](documentation/GPU-FIX-README.md)
|
||||
* [Features](documentation/FEATURES.md)
|
||||
* [Project Structure](documentation/PROJECT_STRUCTURE.md)
|
||||
* [Core Concepts](documentation/CORE_CONCEPTS.md)
|
||||
* [Contributing Guide](documentation/CONTRIBUTING.md)
|
||||
|
||||
Reference in New Issue
Block a user