andrew
b029891107
Added a documentation section to the README with links to the MIT license and GPU Fix documentation. Moved GPU-FIX-README.md to the documentation directory for better organization.
67 lines
1.3 KiB
Markdown
67 lines
1.3 KiB
Markdown
# Nebula
|
|
|
|
|
|
|
|
A customizable and privacy-focused web browser built with Electron.
|
|
|
|
## 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.
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
* [Node.js](https://nodejs.org/) installed.
|
|
|
|
### Installation
|
|
|
|
1. Clone the repository:
|
|
```sh
|
|
git clone https://github.com/Bobbybear007/NebulaBrowser.git
|
|
```
|
|
2. Navigate to the project directory:
|
|
```sh
|
|
cd NebulaBrowser
|
|
```
|
|
3. Install Electron:
|
|
```sh
|
|
npm install --save-dev electron@latest
|
|
```
|
|
|
|
### Running the Application
|
|
|
|
To start the browser, run the following command:
|
|
|
|
```sh
|
|
npm start
|
|
```
|
|
|
|
## Building the Application
|
|
|
|
To build the application for your platform, run:
|
|
|
|
```sh
|
|
npm run dist
|
|
```
|
|
|
|
This will create a distributable file in the `dist` directory.
|
|
|
|
## Technologies Used
|
|
|
|
* [Electron](https://www.electronjs.org/)
|
|
* HTML, CSS, JavaScript
|
|
|
|
## License
|
|
|
|
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) |