sneedium/README.md

30 lines
1,005 B
Markdown
Raw Normal View History

2023-03-02 17:26:33 -06:00
# F-Stopium
2023-03-03 08:31:45 -06:00
A basic web browser in Electron. ***Now with our own, functioning adblocker!***
2023-03-02 15:42:38 -06:00
A basic Electron application needs just these files:
- `package.json` - Points to the app's main file and lists its details and dependencies.
- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
- `index.html` - A web page to render. This is the app's **renderer process**.
- `preload.js` - A content script that runs before the renderer process loads.
## To Use
To clone and run this repository you'll need [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
2023-03-02 15:42:38 -06:00
```bash
# Install dependencies
npm install
# Run the app
npm start
```
## License
2023-03-02 17:26:33 -06:00
[MIT Modified](LICENSE.md)
2023-03-02 18:34:30 -06:00
## Disclaimer
2023-03-03 09:25:57 -06:00
"Insider's Look" builds are outdated and meant for people who are just testing core functionality by default, and aren't interested in changes! If you want changes, compile it.